From 202ed7b72b76c62633621c658411c285c9c3aa30 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 19 Feb 2018 16:20:56 +0100 Subject: [PATCH] Polish --- .../export/wavefront/WavefrontProperties.java | 7 +--- .../appendix-application-properties.adoc | 2 +- .../asciidoc/production-ready-features.adoc | 33 +++++++++++++++++++ 3 files changed, 35 insertions(+), 7 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontProperties.java index 14e46f64303..d1262265b9c 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/wavefront/WavefrontProperties.java @@ -31,12 +31,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties; public class WavefrontProperties extends StepRegistryProperties { /** - * URI to which metrics are published. May 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. + * URI to ship metrics to. */ private URI uri; diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index 4c7ce88a384..1dc142a9e96 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -1396,7 +1396,7 @@ content into your application. Rather, pick only the properties that you need. management.metrics.export.wavefront.enabled= # Whether exporting of metrics to this backend is enabled. management.metrics.export.wavefront.global-prefix= # Global prefix to separate metrics originating from this app's white box instrumentation from those originating from other Wavefront integrations when viewed in the Wavefront UI. management.metrics.export.wavefront.source= # Unique identifier for the app instance that is the source of metrics being published to Wavefront. Defaults to the local host name. - management.metrics.export.wavefront.uri= # URI to which metrics are published. May 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. + management.metrics.export.wavefront.uri= # URI to ship metrics to. management.metrics.use-global-registry=true # Whether auto-configured MeterRegistry implementations should be bound to the global static registry on Metrics. management.metrics.web.client.max-uri-tags=100 # Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter. management.metrics.web.client.record-request-percentiles=false # Whether instrumented requests record percentiles histogram buckets by default. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index c3893cf4c84..8910710d926 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -1126,6 +1126,7 @@ monitoring systems, including: - https://prometheus.io[Prometheus] - https://signalfx.com[SignalFx] - StatsD +- https://www.wavefront.com/[Wavefront] TIP: To learn more about Micrometer's capabilities, please refer to its https://micrometer.io/docs[reference documentation], in particular the @@ -1371,6 +1372,38 @@ You can also change the StatsD line protocol to use (default to Datadog): +[[production-ready-metrics-export-wavefront]] +==== Wavefront +Wavefront registry pushes metrics to Wavefront periodically. If you are exporting +metrics to {micrometer-registry-documentation}/wavefront[Wavefront] directly, your API +token must be provided: + +[source,properties,indent=0] +---- + management.metrics.export.wavefront.api-token=YOUR_API_TOKEN +---- + +Alternatively, you may use a a Wavefront sidecar or an internal proxy set up in your +environment that forwards metrics data to the Wavefront API host: + +[source,properties,indent=0] +---- + management.metrics.export.uri=proxy://localhost:7828 +---- + +TIP: If publishing metrics to a Wavefront proxy (as described in +https://docs.wavefront.com/proxies_installing.html[the documentation]), the host must be +in the `proxy://HOST:PORT` format. + +You can also change the interval at which metrics are sent to Wavefront: + +[source,properties,indent=0] +---- + management.metrics.export.wavefront.steps=30s +---- + + + [[production-ready-metrics-meter]] === Supported Metrics Spring Boot registers the following core metrics when applicable: