Skip to content

Commit

Permalink
docs: add missing and remove unused end-to-end metrics from docs (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
reidmeyer authored Feb 10, 2024
1 parent 5a57069 commit ed9e7b8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 14 deletions.
15 changes: 11 additions & 4 deletions docs/end-to-end.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,25 @@ The end-to-end monitoring feature exports the following metrics.
| Name | Description |
| --- | --- |
| `kminion_end_to_end_messages_produced_total ` | Messages KMinion *tried* to send |
| `kminion_end_to_end_messages_acked_total ` | Messages actually sent and acknowledged by the cluster |
| `kminion_end_to_end_messages_received_total ` | Number of messages received (only counts those that match, i.e. that this instance actually produced itself) |
| `kminion_end_to_end_commits_total` | Number of successful offset commits |
| `kminion_end_to_end_offset_commits_total` | Number of successful offset commits |
| `kminion_end_to_end_messages_lost_total` Number of messages that have been produced successfully but not received within the configured SLA duration |
| `kminion_end_to_end_messages_produced_failed_total` Number of messages failed to produce to Kafka because of a timeout or failure |
| `kminion_end_to_end_offset_commits_total` Counts how many times kminions end-to-end test has committed offsets |

### Histograms

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

### Gauges
| Name | Description |
| --- | --- |
| `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 |

## Config Properties

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

# Name of the topic kminion uses to send its test messages
Expand Down
28 changes: 18 additions & 10 deletions docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,9 @@ kminion_kafka_consumer_group_offset_commits_total{group_id="bigquery-sink"} 1098
# TYPE kminion_end_to_end_messages_produced_total counter
kminion_end_to_end_messages_produced_total 384
# HELP kminion_end_to_end_commits_total Counts how many times kminions end-to-end test has committed messages
# TYPE kminion_end_to_end_commits_total counter
kminion_end_to_end_commits_total 18
# HELP kminion_end_to_end_messages_acked_total Number of messages kafka acknowledged as produced
# TYPE kminion_end_to_end_messages_acked_total counter
kminion_end_to_end_messages_acked_total 383
# HELP kminion_end_to_end_offset_commits_total Counts how many times kminions end-to-end test has committed messages
# TYPE kminion_end_to_end_offset_commits_total counter
kminion_end_to_end_offset_commits_total 18
# 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)
# TYPE kminion_end_to_end_messages_received_total counter
Expand All @@ -127,11 +123,23 @@ kminion_end_to_end_messages_received_total 383
# TYPE kminion_end_to_end_produce_latency_seconds histogram
kminion_end_to_end_produce_latency_seconds_bucket{partitionId="0",le="0.005"} 0
# HELP kminion_end_to_end_commit_latency_seconds Time kafka took to respond to kminion's offset commit
# TYPE kminion_end_to_end_commit_latency_seconds histogram
kminion_end_to_end_commit_latency_seconds_bucket{groupCoordinatorBrokerId="0",le="0.005"} 0
# HELP kminion_end_to_end_offset_commit_latency_seconds Time kafka took to respond to kminion's offset commit
# TYPE kminion_end_to_end_offset_commit_latency_seconds histogram
kminion_end_to_end_offset_commit_latency_seconds_bucket{groupCoordinatorBrokerId="0",le="0.005"} 0
# HELP kminion_end_to_end_roundtrip_latency_seconds Time it took between sending (producing) and receiving (consuming) a message
# TYPE kminion_end_to_end_roundtrip_latency_seconds histogram
kminion_end_to_end_roundtrip_latency_seconds_bucket{partitionId="0",le="0.005"} 0
# HELP kminion_end_to_end_messages_lost_total Number of messages that have been produced successfully but not received within the configured SLA duration
# TYPE kminion_end_to_end_messages_lost_total counter
kminion_end_to_end_messages_lost_total{partition_id="0"} 0
# HELP kminion_end_to_end_messages_produced_failed_total Number of messages failed to produce to Kafka because of a timeout or failure
# TYPE kminion_end_to_end_messages_produced_failed_total counter
kminion_end_to_end_messages_produced_failed_total{partition_id="0"} 0
# 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
# TYPE kminion_end_to_end_messages_produced_in_flight gauge
kminion_end_to_end_messages_produced_in_flight{partition_id="0"} 0
```

0 comments on commit ed9e7b8

Please sign in to comment.