Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 4.62 KB

README.md

File metadata and controls

89 lines (58 loc) · 4.62 KB
Raw

AWS - New Relic log ingestion

AWS Serverless Application that sends log data from CloudWatch Logs to New Relic Infrastructure (Cloud integrations) and New Relic Logging.

Pre-requisites

To forward data to New Relic: New Relic License Key

Configuration

You can configure forwarding of logs to New Relic Infrastructure and/or New Relic Logging using the following two environment variables.

Env. Variable Behavior Value
LICENSE_KEY Needed for sending data to both Infrastructure and Logging. If set, enables forwarding logs to New Relic Infrastructure by default Your New Relic license key, which you can get by following these instructions.
LOGGING_ENABLED determines if logs are forwarded to New Relic Logging "false" by default
INFRA_ENABLED determines if logs are forwarded to New Relic Infrastructure "true" by default
DEBUG_LOGGING_ENABLED determines if additional, debug logs are output during ingestion runs "false" by default

Optional configuration

Env. Variable Decription Default Value
NR_LOGGING_ENDPOINT New Relic ingestion endpoint for Logging https://log-api.newrelic.com/log/v1
NR_INFRA_ENDPOINT New Relic ingestion endpoint for Infra https://cloud-collector.newrelic.com

Configure a Lambda trigger for logging

  • To get your logs streaming to New Relic you will need to attach a trigger to the lambda.
  • To add a trigger, go under Configuration on the lambda management and select CloudWatch.
  • Select your desired log group and set the filter name.
  • Add the trigger and save the lambda.

Configure Retries

You can configure the number of retries you want to perform in case the function fails to send the data in case of communication issues.

Please be aware that more number of retries can make the function run for longer time and therefore increases the probability of having higher costs for Lambda. On the contrary, decreasing the number of retries could increase the probability of data loss.

Recommended number is 3 retries, but you can change the retry behavior by changing the below parameters:

MAX_RETRIES = 3  # Defines the number of retries after lambda failure to deliver data
INITIAL_BACKOFF = 1  # Defines the initial wait seconds until next retry is executed
BACKOFF_MULTIPLIER = 2  # Time multiplier between the retries

As an example, in default above configuration, first retry will happen after 1 second, second retry after 2 seconds and third retry will happen after 4 seconds.

Resources created by the SAM template

There are few resources that will be created when you create the application from the repository:

  • The Lambda function itself
  • A Role used to give execution permissions to the Lambda function based in CloudWatch Logs.

All other lambda configurations not listed in the steps above can be left as the defaults.

Manual Deployment

If your organization restricts access to deploy via SAR, follow these steps below to deploy the log ingestion function manually.

SAM

  1. Clone this repository: git clone https://github.com/newrelic/aws-log-ingestion.git
  2. Install the SAM CLI
  3. Retrieve your New Relic License Key
  4. Build the SAM application (if on Linux -u can be omitted): sam build -u --parameter-overrides 'ParameterKey=NRLicenseKey,ParameterValue=your-license-key-here'
  5. Deploy the SAM application: sam deploy --guided

Additional notes:

  • To set LOGGING_ENABLED: sam build ... --parameter-overrides 'ParameterKey=NRLoggingEnabled,ParameterValue=True'

Serverless

  1. Clone this repository: git clone https://github.com/newrelic/aws-log-ingestion.git
  2. Install Serverless: npm install -g serverless
  3. Install the serverless-python-requirements plugin: sls plugin install -n serverless-python-requirements
  4. If not running Linux, install Docker
  5. Retrieve your New Relic License Key
  6. Set the LICENSE_KEY environment variable: export LICENSE_KEY=your-license-key-here
  7. Deploy the function: sls deploy

Additional notes:

  • To set LOGGING_ENABLED: export LOGGING_ENABLED=True (prior to deploy)