Skip to content

Commit ed9e7b8

Browse files
authored
docs: add missing and remove unused end-to-end metrics from docs (#209)
1 parent 5a57069 commit ed9e7b8

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

docs/end-to-end.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,18 +77,25 @@ The end-to-end monitoring feature exports the following metrics.
7777
| Name | Description |
7878
| --- | --- |
7979
| `kminion_end_to_end_messages_produced_total ` | Messages KMinion *tried* to send |
80-
| `kminion_end_to_end_messages_acked_total ` | Messages actually sent and acknowledged by the cluster |
8180
| `kminion_end_to_end_messages_received_total ` | Number of messages received (only counts those that match, i.e. that this instance actually produced itself) |
82-
| `kminion_end_to_end_commits_total` | Number of successful offset commits |
81+
| `kminion_end_to_end_offset_commits_total` | Number of successful offset commits |
82+
| `kminion_end_to_end_messages_lost_total` Number of messages that have been produced successfully but not received within the configured SLA duration |
83+
| `kminion_end_to_end_messages_produced_failed_total` Number of messages failed to produce to Kafka because of a timeout or failure |
84+
| `kminion_end_to_end_offset_commits_total` Counts how many times kminions end-to-end test has committed offsets |
8385

8486
### Histograms
8587

8688
| Name | Description |
8789
| --- | --- |
8890
| `kminion_end_to_end_produce_latency_seconds ` | Duration until the cluster acknowledged a message. |
89-
| `kminion_end_to_end_commit_latency_seconds` | Duration of offset commits. Has a label for coordinator brokerID that answered the commit request |
91+
| `kminion_end_to_end_offset_commit_latency_seconds` Time kafka took to respond to kminion's offset commit |
9092
| `kminion_end_to_end_roundtrip_latency_seconds ` | Duration from creation of a message, until it was received/consumed again. |
9193

94+
### Gauges
95+
| Name | Description |
96+
| --- | --- |
97+
| `kminion_end_to_end_messages_produced_in_flight` Number of messages that kminion's end-to-end test produced but has not received an answer for yet |
98+
9299
## Config Properties
93100

94101
All config properties related to this feature are located in `minion.endToEnd`.
@@ -100,7 +107,7 @@ All config properties related to this feature are located in `minion.endToEnd`.
100107
topicManagement:
101108
# You can disable topic management, without disabling the testing feature.
102109
# Only makes sense if you have multiple kminion instances, and for some reason only want one of them to create/configure the topic.
103-
# It is strongly recommended to leave this enabled.
110+
# It is strongly recommended to leave this enabled.
104111
enabled: true
105112

106113
# Name of the topic kminion uses to send its test messages

docs/metrics.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,9 @@ kminion_kafka_consumer_group_offset_commits_total{group_id="bigquery-sink"} 1098
111111
# TYPE kminion_end_to_end_messages_produced_total counter
112112
kminion_end_to_end_messages_produced_total 384
113113
114-
# HELP kminion_end_to_end_commits_total Counts how many times kminions end-to-end test has committed messages
115-
# TYPE kminion_end_to_end_commits_total counter
116-
kminion_end_to_end_commits_total 18
117-
118-
# HELP kminion_end_to_end_messages_acked_total Number of messages kafka acknowledged as produced
119-
# TYPE kminion_end_to_end_messages_acked_total counter
120-
kminion_end_to_end_messages_acked_total 383
114+
# HELP kminion_end_to_end_offset_commits_total Counts how many times kminions end-to-end test has committed messages
115+
# TYPE kminion_end_to_end_offset_commits_total counter
116+
kminion_end_to_end_offset_commits_total 18
121117
122118
# HELP kminion_end_to_end_messages_received_total Number of *matching* messages kminion received. Every roundtrip message has a minionID (randomly generated on startup) and a timestamp. Kminion only considers a message a match if it it arrives within the configured roundtrip SLA (and it matches the minionID)
123119
# TYPE kminion_end_to_end_messages_received_total counter
@@ -127,11 +123,23 @@ kminion_end_to_end_messages_received_total 383
127123
# TYPE kminion_end_to_end_produce_latency_seconds histogram
128124
kminion_end_to_end_produce_latency_seconds_bucket{partitionId="0",le="0.005"} 0
129125
130-
# HELP kminion_end_to_end_commit_latency_seconds Time kafka took to respond to kminion's offset commit
131-
# TYPE kminion_end_to_end_commit_latency_seconds histogram
132-
kminion_end_to_end_commit_latency_seconds_bucket{groupCoordinatorBrokerId="0",le="0.005"} 0
126+
# HELP kminion_end_to_end_offset_commit_latency_seconds Time kafka took to respond to kminion's offset commit
127+
# TYPE kminion_end_to_end_offset_commit_latency_seconds histogram
128+
kminion_end_to_end_offset_commit_latency_seconds_bucket{groupCoordinatorBrokerId="0",le="0.005"} 0
133129
134130
# HELP kminion_end_to_end_roundtrip_latency_seconds Time it took between sending (producing) and receiving (consuming) a message
135131
# TYPE kminion_end_to_end_roundtrip_latency_seconds histogram
136132
kminion_end_to_end_roundtrip_latency_seconds_bucket{partitionId="0",le="0.005"} 0
133+
134+
# HELP kminion_end_to_end_messages_lost_total Number of messages that have been produced successfully but not received within the configured SLA duration
135+
# TYPE kminion_end_to_end_messages_lost_total counter
136+
kminion_end_to_end_messages_lost_total{partition_id="0"} 0
137+
138+
# HELP kminion_end_to_end_messages_produced_failed_total Number of messages failed to produce to Kafka because of a timeout or failure
139+
# TYPE kminion_end_to_end_messages_produced_failed_total counter
140+
kminion_end_to_end_messages_produced_failed_total{partition_id="0"} 0
141+
142+
# HELP kminion_end_to_end_messages_produced_in_flight Number of messages that kminion's end-to-end test produced but has not received an answer for yet
143+
# TYPE kminion_end_to_end_messages_produced_in_flight gauge
144+
kminion_end_to_end_messages_produced_in_flight{partition_id="0"} 0
137145
```

0 commit comments

Comments
 (0)