From 68fdd49a0b663e01f548a7b0995ecfabbdf9f9dc Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Sun, 22 Jan 2017 15:22:00 +0000 Subject: [PATCH] Document payload types of messages sent to metricsChannel Closes gh-7790 --- .../src/main/asciidoc/production-ready-features.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index e37612036a5..d4af455cb6c 100644 --- a/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -1448,10 +1448,12 @@ replaced with a `DropwizardMetricServices`, which is a wrapper around the `Metri [[production-ready-metrics-message-channel-integration]] === Message channel integration If a `MessageChannel` bean called `metricsChannel` exists, then a `MetricWriter` will be -created that writes metrics to that channel. The writer is automatically hooked up to an -exporter (as for all writers), so all metric values will appear on the channel, and -additional analysis or actions can be taken by subscribers (it's up to you to provide the -channel and any subscribers you need). +created that writes metrics to that channel. Each message sent to the channel will contain +a {dc-spring-boot-actuator}/metrics/writer/Delta.{dc-ext}[`Delta`] or +{dc-spring-boot-actuator}/metrics/Metric.{dc-ext}[`Metric`] payload and have a `metricName` +header. The writer is automatically hooked up to an exporter (as for all writers), so all +metric values will appear on the channel, and additional analysis or actions can be taken +by subscribers (it's up to you to provide the channel and any subscribers you need).