From f2e1b63460f978b7d607b5fd7469f1262d1e9d4a Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Wed, 27 Sep 2017 12:57:19 -0400 Subject: [PATCH] GH-201: Move metrics doc to the main overview doc Fixes #201 --- .../src/main/asciidoc/index.adoc | 2 -- .../src/main/asciidoc/metrics.adoc | 8 -------- .../src/main/asciidoc/overview.adoc | 10 ++++++++++ 3 files changed, 10 insertions(+), 10 deletions(-) delete mode 100644 spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/metrics.adoc diff --git a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/index.adoc b/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/index.adoc index 6d41943fc..b5bfdec75 100644 --- a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/index.adoc +++ b/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/index.adoc @@ -26,8 +26,6 @@ include::overview.adoc[] include::dlq.adoc[] -include::metrics.adoc[] - = Appendices [appendix] include::building.adoc[] diff --git a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/metrics.adoc b/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/metrics.adoc deleted file mode 100644 index b40755c41..000000000 --- a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/metrics.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[[kafka-metrics]] -== Kafka Metrics - -Kafka binder module exposes the following metrics: - -`spring.cloud.stream.binder.kafka.someGroup.someTopic.lag` - this metric indicates how many messages have not been yet consumed from given binder's topic by given consumer group. -For example if the value of the metric `spring.cloud.stream.binder.kafka.myGroup.myTopic.lag` is `1000`, then consumer group `myGroup` has `1000` messages to waiting to be consumed from topic `myTopic`. -This metric is particularly useful to provide auto-scaling feedback to PaaS platform of your choice. \ No newline at end of file diff --git a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc b/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc index 0d262b840..d84af136b 100644 --- a/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc +++ b/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc @@ -563,3 +563,13 @@ The payload of the `ErrorMessage` for a send failure is a `KafkaSendFailureExcep * `record` - the raw `ProducerRecord` that was created from the `failedMessage` There is no automatic handling of these exceptions (such as sending to a <>); you can consume these exceptions with your own Spring Integration flow. + + +[[kafka-metrics]] +== Kafka Metrics + +Kafka binder module exposes the following metrics: + +`spring.cloud.stream.binder.kafka.someGroup.someTopic.lag` - this metric indicates how many messages have not been yet consumed from given binder's topic by given consumer group. +For example if the value of the metric `spring.cloud.stream.binder.kafka.myGroup.myTopic.lag` is `1000`, then consumer group `myGroup` has `1000` messages to waiting to be consumed from topic `myTopic`. +This metric is particularly useful to provide auto-scaling feedback to PaaS platform of your choice. \ No newline at end of file