Edge Delta New Relic Output

Stream data to New Relic.

  3 minute read  

Version 2 is no longer supported. This section is for historical reference only.

Overview

The New Relic output will stream analytics and insights to a New Relic environment. Before you can create an output, you must have available the New Relic API License key. See this document from New Relic.

Example

    - name: newrelic
      type: newrelic
      log_host: "<ADD NEWRELIC LOG_HOST>"
      metric_host: "<ADD NEWRELIC METRIC_HOST>"
      api_key: {{Env "TEST_NR_APIKEY"}}
      features: metric
      custom_tags:
        "app": "c_pos_transaction_manager"
        "region": "us-west-2"
        "File Path": "{{.FileGlobPath}}"
        "K8s PodName": "{{.K8sPodName}}"
        "K8s Namespace": "{{.K8sNamespace}}"
        "K8s ControllerKind": "{{.K8sControllerKind}}"
        "K8s ContainerName": "{{.K8sContainerName}}"
        "K8s ContainerImage": "{{.K8sContainerImage}}"
        "K8s ControllerLogicalName": "{{.K8sControllerLogicalName}}"
        "ECSCluster": "{{.ECSCluster}}"
        "ECSContainerName": "{{.ECSContainerName}}"
        "ECSTaskVersion": "{{.ECSTaskVersion}}"
        "ECSTaskFamily": "{{.ECSTaskFamily}}"
        "DockerContainerName": "{{.DockerContainerName}}"
        "ConfigID": "{{.ConfigID}}"
        "Host": "{{.Host}}"
        "Source": "{{.Source}}"
        "SourceType": "{{.SourceType}}"
        "Tag": "{{.Tag}}"

Parameters

name

Required

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

name: newrelic

integration_name

Optional

This parameter refers to the organization-level integration created in the Integrations page.

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

integration_name: orgs-newrelic

type

Optional

Enter newrelic.

type: newrelic

log_host

Optional

Enter the New Relic log host.

log_host: "<ADD NEWRELIC LOG_HOST>"

metric_host

Optional

Enter the New Relic metric host to send metric data.

metric_host: "<ADD NEWRELIC METRIC_HOST>"

api_key

Required

Enter a New Relic API License key.

api_key: '{{ Env "TEST_NR_APIKEY" }}'

event_host

Optional

Enter the New Relic event host.

event_host: "<ADD NEWRELIC EVENT_HOST>"

account_name

Optional

Enter the New Relic account ID.

account_name: '{{ Env "TEST_NR_ACCOUNT_ID" }}'

alert_as_event

Optional

Enter true or false to send alerts as events.

alert_as_event: true

custom_tags

Optional

This parameter defines key-value pairs that are streamed with every request.

      custom_tags:
        "app": "s_pos_transaction_manager"
        "region": "us-west-2"
        "File Path": "{{.FileGlobPath}}"
        "K8s PodName": "{{.K8sPodName}}"
        "K8s Namespace": "{{.K8sNamespace}}"
        "K8s ControllerKind": "{{.K8sControllerKind}}"
        "K8s ContainerName": "{{.K8sContainerName}}"
        "K8s ContainerImage": "{{.K8sContainerImage}}"
        "K8s ControllerLogicalName": "{{.K8sControllerLogicalName}}"
        "ECSCluster": "{{.ECSCluster}}"
        "ECSContainerName": "{{.ECSContainerName}}"
        "ECSTaskVersion": "{{.ECSTaskVersion}}"
        "ECSTaskFamily": "{{.ECSTaskFamily}}"
        "DockerContainerName": "{{.DockerContainerName}}"
        "ConfigID": "{{.ConfigID}}"
        "Host": "{{.Host}}"
        "Source": "{{.Source}}"
        "SourceType": "{{.SourceType}}"
        "Tag": "{{.Tag}}"

features

Optional

This parameter defines which data types to stream to the destination.

To learn more, see the following section on supported feature types.

features: metric,alert

buffer_ttl

Optional

Enter a length of time to retry failed streaming data.

After this length of time is reached, the failed streaming data will no longer be tried.

buffer_ttl: 2h

buffer_path

Optional

Enter a folder path to temporarily store failed streaming data.

The failed streaming data will be retried until the data reaches its destinations or until the Buffer TTL value is reached.

If you enter a path that does not exist, then the agent will create directories, as needed.

buffer_path: /var/log/edgedelta/pushbuffer/

buffer_max_bytesize

Optional

Enter the maximum size of failed streaming data that you want to retry.

If the failed streaming data is larger than this size, then the failed streaming data will not be retried.

buffer_max_bytesize: 100MB

Supported Features

See Streaming Features.

Feature Type Supported?
Log Yes
Metrics Yes
Alert as event Yes
Alert as log Yes
Health Yes
Dimensions as attribute Yes
Send as is No
Send as JSON No
Custom tags Yes
EDAC enrichment No
Message template No
outgoing_bytes.sum Yes
outgoing__raw_bytes.sum No
outgoing_lines.count Yes
output buffering to disk No