io.micrometer.wavefront

Interface WavefrontConfig

All Superinterfaces:

io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.step.StepRegistryConfig

public interface WavefrontConfig
extends io.micrometer.core.instrument.step.StepRegistryConfig

Configuration for WavefrontMeterRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
static WavefrontConfig	DEFAULT_DIRECT Publishes directly to the Wavefront API, not passing through a sidecar.
static WavefrontConfig	DEFAULT_PROXY Publishes to a wavefront sidecar running out of process.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	apiToken() Required when publishing directly to the Wavefront API host, otherwise does nothing.
default java.lang.String	globalPrefix() Wavefront metrics are grouped hierarchically by name in the UI.
default java.lang.String	prefix()
default java.lang.String	source()
default java.time.Duration	step()
default java.lang.String	uri()

Methods inherited from interface io.micrometer.core.instrument.step.StepRegistryConfig

batchSize, connectTimeout, enabled, numThreads, readTimeout

Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig

get

Field Detail

DEFAULT_PROXY

static final WavefrontConfig DEFAULT_PROXY

Publishes to a wavefront sidecar running out of process.

DEFAULT_DIRECT

static final WavefrontConfig DEFAULT_DIRECT

Publishes directly to the Wavefront API, not passing through a sidecar.

Method Detail

step

default java.time.Duration step()

Specified by:

step in interface io.micrometer.core.instrument.step.StepRegistryConfig

prefix

default java.lang.String prefix()

Specified by:

prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig

uri

default java.lang.String uri()

Returns:

The URI to publish metrics to. The URI could represent a Wavefront sidecar or the Wavefront API host. This host could also represent an internal proxy set up in your environment that forwards metrics data to the Wavefront API host.

If publishing metrics to a Wavefront proxy (as described in https://docs.wavefront.com/proxies_installing.html), the host must be in the proxy://HOST:PORT format.

source

default java.lang.String source()

Returns:

Unique identifier for the app instance that is publishing metrics to Wavefront. Defaults to the local host name.

apiToken

@Nullable
default java.lang.String apiToken()

Required when publishing directly to the Wavefront API host, otherwise does nothing.

Returns:

The Wavefront API token.

globalPrefix

@Nullable
default java.lang.String globalPrefix()

Wavefront metrics are grouped hierarchically by name in the UI. Setting a global prefix separates metrics originating from this app's whitebox instrumentation from those originating from other Wavefront integrations.

Returns:

A prefix to add to every metric.