npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

serverless-newrelic-alerts

v2.2.2

Published

A serverless plugin to add New Relic alerts to a AWS resources

Downloads

4

Readme

New Relic Serverless Plugin

NPM

CircleCI

=======

This serverless plugin allows adding New Relic alerts to resources. The sole responsibility of the plugin is to generate additional CloudFormation code with Custom Resources, that will create New Relic alerts for the function.

The plugin development plans include templates that can be used with 1-2 lines of code in serverless.yml

Usage

plugins:
  - serverless-newrelic-alerts

custom:
  newrelic:
    customPolicyName: Custom NR policy name
    incidentPreference: 'PER_CONDITION'
    policyServiceToken: arn:aws:test-policy_service_token
    infrastructureConditionServiceToken: arn:aws:test-infrastructure_condition_service_token
    violationCloseTimer: 24
    alerts:
      - type: functionDuration1Sec
        title: 'Duration 1 sec'
        runbookURL: 'https://aws.amazon.com/lambda/'
      - functionErrors
      - type: apiGateway4XXErrors
        enabled: true
      - apiGateway5XXErrors
      - type: sqsDlqVisibleMessages
        filter: '-dlq'
      - type: dynamoDbSystemErrors
        enabled: false

functions:
  under-newrelic-mntrng:
    handler: index.endpoint
    alerts:
      - type: functionErrors
        enabled: true
        title: 'Dummy Errors'
        runbookURL: 'https://aws.amazon.com/lambda/'
      - functionThrottles

Examples of generated CF:

  • Policy (if customPolicyName isn't provided)
{
  "PluginTestNewRelicPolicy": {
    "Type": "Custom::NewRelicPolicy",
    "Properties": {
      "ServiceToken": "arn:aws:test-policy_service_token",
      "policy": {
        "name": "PluginTest TEST",
        "incident_preference": "PER_POLICY"
      }
    }
  }
}
  • Policy with custom name
{
  "CustomPolicyNameNewRelicPolicy": {
    "Type": "Custom::NewRelicPolicy",
    "Properties": {
      "ServiceToken": "arn:aws:test-policy_service_token",
      "policy": {
        "name": "Custom policy name",
        "incident_preference": "PER_POLICY"
      }
    }
  }
}
  • Infrastructure condition
{
  "FunctionThrottlesInfrastructureCondition": {
    "Type": "Custom::NewRelicInfrastructureCondition",
    "Properties": {
      "ServiceToken": "arn:aws:test-infrastructure_condition_service_token",
      "policy_id": {
        "Ref": "PluginTestNewRelicPolicy"
      },
      "data": {
        "type": "infra_metric",
        "name": "PluginTest TEST - Function Throttles",
        "enabled": true,
        "filter": "DEPENDS ON METRIC TYPE",
        "violation_close_timer": 24,
        "policy_id": {
          "Ref": "PluginTestNewRelicPolicy"
        },
        "event_type": "DEPENDS ON METRIC TYPE",
        "select_value": "DEPENDS ON METRIC TYPE",
        "comparison": "DEPENDS ON METRIC TYPE",
        "critical_threshold": {
          "value": "DEPENDS ON METRIC TYPE",
          "duration_minutes": "DEPENDS ON METRIC TYPE",
          "time_function": "DEPENDS ON METRIC TYPE",
        },
        "integration_provider": "DEPENDS ON METRIC TYPE",
      }
    }
  }
}

Configuration

  • policyServiceToken - arn of lambda managing policy (required)
  • infrastructureConditionServiceToken - arn of lambda managing infrastructure conditions (required)
  • violationCloseTimer - after what time alert conditions should be force-closed - 24h by default, pass 0 to turn off auto closing
  • policyName - Custom name for the NewRelic policy if not specified genareted from serviceName in the serverless.yaml of the target app
  • incidentPreference - possible values: 'PER_CONDITION', 'PER_CONDITION_AND_TARGET', 'PER_POLICY'. If you don't specify this field, it will be set to 'PER_POLICY'
  • alerts - list of required alerts. It can be list of existing alerts aliases or each alert can contain advanced configuration:
    • type - alias name to existing alert type (e.x. functionThrottles)
    • enabled - boolean param which indicates whether it triggers alams or not
    • runbookURL - URL for your runbook instructions
    • title - name of NewRelic alert

List of preconfigured metrics

Lambda

Alerts configured in custom section of serverless.yml will be applied to all functions in stack unless function disable it, alerts configured on function level will be applied only to chosen functions.

Filtering performed by displayName

functions:
  under-newrelic-mntrng:
    handler: index.endpoint
    alerts:
      - name: functionErrors
        enabled: false
      - functionThrottles

Metrics:

  • functionDuration1Sec
"select_value": "provider.duration.Maximum",
"comparison": "above",
"critical_threshold": {
  "value": 1000,
  "duration_minutes": 5,
  "time_function": "all"
}
  • functionErrors
"select_value": "provider.errors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • functionThrottles
"select_value": "provider.throttles.Maximum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}

Api Gateway

Alerts configured in custom section of serverless.yml will be applied to all apiGateways in stack.

Filtering performed by apiName.

Metrics:

  • apiGateway4XXErrors
"select_value": "provider.4xxError.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • apiGateway5XXErrors
"select_value": "provider.5xxError.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}

SQS

Filtering performed by queueName.

DLQ Metrics:

Alerts configured in custom section of serverless.yml will be applied to all sqs with name ending with -dlq in stack.

  • sqsDlqVisibleMessages
"select_value": "provider.approximateNumberOfMessagesVisible.Maximum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}

DynamoDb

Alerts configured in custom section of serverless.yml will be applied to all tables in stack. Filtering performed by tableName.

Metric:

  • dynamoDbBatchGetSystemErrors
"select_value": "provider.batchGetSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbBatchWriteSystemErrors
"select_value": "provider.batchWriteSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbDeleteSystemErrors
"select_value": "provider.deleteSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbGetSystemErrors
"select_value": "provider.getSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbPutSystemErrors
"select_value": "provider.putSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbQuerySystemErrors
"select_value": "provider.querySystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbScanSystemErrors
"select_value": "provider.scanSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbUpdateSystemErrors
"select_value": "provider.updateSystemErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbUserErrors
"select_value": "provider.userErrors.Sum",
"comparison": "above",
"critical_threshold": {
  "value": 3,
  "duration_minutes": 5,
  "time_function": "all"
}
  • dynamoDbSystemErrors - alias for batch of system errors metrics:
dynamoDbBatchGetSystemErrors
dynamoDbBatchWriteSystemErrors
dynamoDbDeleteSystemErrors
dynamoDbGetSystemErrors
dynamoDbPutSystemErrors
dynamoDbQuerySystemErrors
dynamoDbScanSystemErrors
dynamoDbUpdateSystemErrors