--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/vmware/wavefront-adapter-for-istio' REPO source_repo: https://github.com/vmware/wavefront-adapter-for-istio title: Wavefront by VMware description: Adapter to deliver metrics to Wavefront by VMware. location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/wavefront.html layout: partner-component generator: protoc-gen-docs provider: VMware, Inc. contact_email: veniln@vmware.com support_link: source_link: https://github.com/vmware/wavefront-adapter-for-istio latest_release_link: https://github.com/vmware/wavefront-adapter-for-istio/releases/tag/0.1.1 helm_chart_link: istio_versions: "1.0.3, 1.0.4" supported_templates: metric logo_link: https://github.com/vmware/wavefront-adapter-for-istio/raw/master/docs/images/logo.png number_of_entries: 9 ---

The `wavefront` adapter collects metrics and makes them available to Wavefront by VMware.

This adapter supports the metric template.

## Params

Configuration format for the `wavefront` adapter.

Field | Type | Description
--- | --- | ---
`direct` | `Params.WavefrontDirect (oneof)` | The credentials for direct ingestion.
`proxy` | `Params.WavefrontProxy (oneof)` | The credentials for ingestion via a Wavefront Proxy.
`flushInterval` | `google.protobuf.Duration` | The metrics flush interval.
`source` | `string` | The source tag for all metrics handled by this adapter.
`prefix` | `string` | The prefix to prepend all metrics handled by the adapter.
`metrics` | `Params.MetricInfo[]` | The set of metrics to publish to Wavefront.
`logs` | `Params.Logs` | The log configuration.

## Params.Logs

Describes the logging configuration.

Field | Type | Description
--- | --- | ---
`level` | `string` | The log level (one of error, warn, info, debug, or none). Ex: info

## Params.MetricInfo

Describes how a metric should be represented on Wavefront.

Field | Type | Description
--- | --- | ---
`name` | `string` | The metric name. (Optional)
`instanceName` | `string` | The fully qualified Istio metric instance name.
`type` | `Params.MetricInfo.Type` | The metric type.
`sample` | `Params.MetricInfo.Sample` | For metrics with type HISTOGRAM, this describes the sample definition.

## Params.MetricInfo.Sample

Describes a sample as in the rcrowley/go-metrics library.

Field | Type | Description
--- | --- | ---
`expDecay` | `Params.MetricInfo.Sample.ExpDecay (oneof)` | Definition of an exponentially decaying sample.
`uniform` | `Params.MetricInfo.Sample.Uniform (oneof)` | Definition of a uniform sample.

## Params.MetricInfo.Sample.ExpDecay

Describes an exponentially decaying sample.

Field | Type | Description
--- | --- | ---
`reservoirSize` | `int32` | The reservoir size.
`alpha` | `double` | The alpha.

## Params.MetricInfo.Sample.Uniform

Describes a uniform sample.

Field | Type | Description
--- | --- | ---
`reservoirSize` | `int32` | The reservoir size.

## Params.MetricInfo.Type

Describes metric types as in Wavefront.

Name | Description
--- | ---
`UNKNOWN` | Reserved for unknown metric types.
`GAUGE` | Represents a gauge metric type.
`COUNTER` | Represents a counter metric type.
`DELTA_COUNTER` | Represents a delta counter metric type.
`HISTOGRAM` | Represents a histogram metric type.

## Params.WavefrontDirect

Describes Wavefront Server credentials.

Field | Type | Description
--- | --- | ---
`server` | `string` | The Wavefront server URL. Ex: https://mydomain.wavefront.com
`token` | `string` | The Wavefront API token.

## Params.WavefrontProxy

Describes Wavefront Proxy credentials.

Field | Type | Description
--- | --- | ---
`address` | `string` | The wavefront proxy address. Ex: 192.168.99.100:2878