README
¶
Deprecated New Relic Exporter
New Relic native OTLP ingest became Generally Available in September 2021. This vendor specific exporter is being deprecated and will become unavailable May 1st 2022.
To send OpenTelemetry data to New Relic, use the OTLP gRPC Exporter instead, with configuration as described here.
Overview
This exporter supports sending trace, metric, and log data to New Relic
Please review the Collector's security documentation, which contains recommendations on securing sensitive information such as the API key required by this exporter.
Configuration
The following common configuration options are supported:
- One or both of the following are required:
apikey: Your New Relic Insights Insert API Key.api_key_header: Request header to read New Relic Insights Insert API Key from.
timeout(Optional): Amount of time spent attempting a request before abandoning and dropping data. Default is 15 seconds.host_override(Optional): Overrides the host to which data is sent. The URL will be generated in the form: https://$host/$path. Only set the the host portion of the URL. The path component CANNOT be overridden.
Basic example:
exporters:
newrelic:
apikey: super-secret-api-key
timeout: 30s
Configuration option can be overridden by telemetry signal (i.e., traces,
metrics, and logs). This is especially important if you need to use the
host_override option because the exporter defaults to sending data to New
Relic's US data centers. For other use cases refer to
OpenTelemetry: Advanced configuration.
Example of overriding options by telemetry signal:
exporters:
newrelic:
apikey: super-secret-api-key
timeout: 30s
# host_override is set to send data to New Relic's EU data centers.
traces:
host_override: trace-api.eu.newrelic.com
timeout: 20s
metrics:
host_override: metric-api.eu.newrelic.com
logs:
host_override: log-api.eu.newrelic.com
Find and use your data
Once the exporter is sending data you can start to explore your data in New Relic:
- Metric data: see Metric API docs.
- Trace/span data: see Trace API docs.
- Log data: see Log docs
For general querying information, see:
Documentation
¶
Index ¶
Constants ¶
const EuKeyPrefix = "eu01xx"
Variables ¶
This section is empty.
Functions ¶
func MetricViews ¶ added in v0.25.0
MetricViews return metric views for Kafka receiver.
func NewFactory ¶ added in v0.9.0
func NewFactory() component.ExporterFactory
NewFactory creates a factory for New Relic exporter.
Types ¶
type Config ¶
type Config struct {
config.ExporterSettings `mapstructure:",squash"`
// CommonConfig stores the base configuration for each endpoint.
CommonConfig EndpointConfig `mapstructure:",squash"`
// TracesConfig stores the configuration for the traces endpoint.
TracesConfig EndpointConfig `mapstructure:"traces"`
// MetricsConfig stores the configuration for the metrics endpoint.
MetricsConfig EndpointConfig `mapstructure:"metrics"`
// LogsConfig stores the configuration for the logs endpoint.
LogsConfig EndpointConfig `mapstructure:"logs"`
}
Config defines configuration options for the New Relic exporter.
type EndpointConfig ¶ added in v0.25.0
type EndpointConfig struct {
// APIKey is the required authentication credentials for New Relic APIs. This field specifies the default key.
APIKey string `mapstructure:"apikey"`
// APIKeyHeader may be specified to instruct the exporter to extract the API key from the request context.
APIKeyHeader string `mapstructure:"api_key_header"`
// HostOverride overrides the endpoint.
HostOverride string `mapstructure:"host_override"`
// TimeoutSettings is the total amount of time spent attempting a request,
// including retries, before abandoning and dropping data. Default is 5
// seconds.
TimeoutSettings exporterhelper.TimeoutSettings `mapstructure:",squash"`
// RetrySettings defines configuration for retrying batches in case of export failure.
// The current supported strategy is exponential backoff.
RetrySettings exporterhelper.RetrySettings `mapstructure:"retry"`
// contains filtered or unexported fields
}
EndpointConfig defines configuration for a single endpoint in the New Relic exporter.
Source Files