--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/newrelic/newrelic-istio-adapter' REPO source_repo: https://github.com/newrelic/newrelic-istio-adapter title: New Relic description: An Istio Mixer adapter to send telemetry data to New Relic. location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/newrelic.html layout: partner-component generator: protoc-gen-docs provider: New Relic, Inc. source_link: https://github.com/newrelic/newrelic-istio-adapter latest_release_link: https://github.com/newrelic/newrelic-istio-adapter/releases supported_templates: metric, tracespan number_of_entries: 3 ---

An Istio Mixer adapter to send telemetry data to New Relic.

## Params

Configuration format for the `newrelic` adapter.

Field | Type | Description
--- | --- | ---
`namespace` | `string` | Optional. The namespace is used as a prefix for metric names in New Relic. An example: for a metric named `requestSize` with a namespace of `istio`, the full metric name in New Relic becomes `istio.requestSize`.
`metrics` | `map<string, Params.MetricInfo>` | Map of Istio metric instance names and the corresponding New Relic MetricInfo specification. This identifies what to send New Relic and in what form it should be sent. Any metric instances Istio sends to the adapter but not specified here will be dropped and not exported to New Relic.

## Params.MetricInfo

Describes how to represent an Istio metric instance in New Relic.

Field | Type | Description
--- | --- | ---
`name` | `string` | Recommended. The name of the metric (scoped by namespaces) in New Relic. The name must not be empty and the fully qualified name (prefixed with the namespace) must contain 255 16-bit code units (UTF-16) or less. Otherwise, an error will be logged and no metric will be sent to New Relic.
`type` | `Params.MetricInfo.Type` | Required. New Relic metric type to interpret the Istio instance as.

## Params.MetricInfo.Type

New Relic Metric types.

Name | Description
--- | ---
`UNSPECIFIED` | Default and invalid unspecified type. An error will be logged and the metric dropped if unspecified.

`GAUGE`

A New Relic `Gauge` type.

This metric type represents the instantaneous state of something or process that can both increase and decrease in value.

For example, this metric type would be used to record:

- the network throughput of a service
- the storage capacity used on a server
- the size of a queue

`COUNT`

A New Relic `Count` type.

This metric type represents the number of occurrences for an event within a time window. It is important to note that this is not the cumulative tally of occurrences since the beginning of measurements. Rather, this metric type represents the change in the cumulative tally of events within a time window.

For example, this metric type would be used to record:

- the number of requests to a service
- the number of tasks submitted to a processor
- the number of errors produced

`SUMMARY`

New Relic `Summary` type.

This metric type reports aggregated information about discrete events. The information is recorded as a count of events, average event values, sum of event values, and the minimum and maximum event values observed within a time window.

For example, this metric type would be used to record:

- the duration and count of requests to service
- the duration and count of database transactions
- the time each message spent in a queue