IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Nagios_nsca output plugin Opentsdb output plugin »
Elastic Docs ›Logstash Reference [5.6] ›Output plugins

Newrelic output plugin

edit

Newrelic output plugin

edit

This plugin cannot be installed on the current version of Logstash. We are working on resolving this problem.

This output sends logstash events to New Relic Insights as custom events.

You can learn more about New Relic Insights here: https://docs.newrelic.com/docs/insights/new-relic-insights/understanding-insights/new-relic-insights

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

newrelic {
    account_id => ...
    insert_key => ...
}

Available configuration options:

Setting Input type Required Default value

account_id

string

Yes

batch

boolean

No

true

batch_events

number

No

10

batch_timeout

number

No

5

codec

codec

No

"plain"

enable_metric

boolean

No

true

event_type

string

No

"LogstashEvent"

id

string

No

insert_key

string

Yes

proto

string

No

"https"

proxy_host

string

No

proxy_password

password

No

""

proxy_port

number

No

80

proxy_user

string

No

workers

<<,>>

No

1

Details

edit

 

account_id

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Your New Relic account ID. This is the 5 or 6-digit number found in the URL when you are logged into New Relic: account_id/…​

batch

edit
  • Value type is boolean
  • Default value is true

Batch Processing - all optional This plugin uses the New Relic Insights REST API to send data. To make efficient REST API calls, we will buffer a certain number of events before flushing that out to Insights.

batch_events

edit
  • Value type is number
  • Default value is 10

This setting controls how many events will be buffered before sending a batch of events.

batch_timeout

edit
  • Value type is number
  • Default value is 5

This setting controls how long the output will wait before sending a batch of a events, should the minimum specified in batch_events not be met yet.

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

event_type

edit
  • Value type is string
  • Default value is "LogstashEvent"

The name for your event type. Use alphanumeric characters only. If left out, your events will be stored under "logstashEvent".

id

edit
  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

insert_key

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

Your Insights Insert Key. You will need to generate one if you haven’t already, as described here: https://docs.newrelic.com/docs/insights/new-relic-insights/adding-querying-data/inserting-custom-events-insights-api#register

proto

edit
  • Value type is string
  • Default value is "https"

Should the log events be sent to Insights over https instead of plain http (typically yes).

proxy_host

edit
  • Value type is string
  • There is no default value for this setting.

Proxy info - all optional If using a proxy, only proxy_host is required.

proxy_password

edit
  • Value type is password
  • Default value is ""

Proxy_password should be left out if connecting to your proxy unauthenticated.

proxy_port

edit
  • Value type is number
  • Default value is 80

Proxy_port will default to port 80 if left out.

proxy_user

edit
  • Value type is string
  • There is no default value for this setting.

Proxy_user should be left out if connecting to your proxy unauthenticated.

workers

edit
  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne

« Nagios_nsca output plugin Opentsdb output plugin »