Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial addition of Kafka metrics. #2485

Merged
merged 18 commits into from
May 9, 2022
Merged

Initial addition of Kafka metrics. #2485

Changes from 3 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
031445e
Initial addition of Kafka metrics.
carlosalberto Apr 11, 2022
0dee47b
Merge branch 'main' into kafka-metrics-addition
carlosalberto Apr 11, 2022
51683b4
Update specification/metrics/semantic_conventions/instrumentation/kaf…
carlosalberto Apr 12, 2022
7ed346d
First pass of feedback.
carlosalberto Apr 20, 2022
0729f57
Merge branch 'main' into kafka-metrics-addition
carlosalberto Apr 27, 2022
1d768ea
Merge branch 'main' into kafka-metrics-addition
carlosalberto May 4, 2022
792222b
Remove metrics that may need Summary/Histogram points.
carlosalberto May 4, 2022
26bfbc9
Merge branch 'main' into kafka-metrics-addition
carlosalberto May 4, 2022
2b8ba12
Apply jmacd's suggestions.
carlosalberto May 6, 2022
e8128b2
A little naming tuning.
carlosalberto May 6, 2022
f6751c9
Lint.
carlosalberto May 6, 2022
d9600ce
Merge branch 'main' into kafka-metrics-addition
carlosalberto May 6, 2022
6277132
Update specification/metrics/semantic_conventions/instrumentation/kaf…
carlosalberto May 6, 2022
ad547a2
More tuning.
carlosalberto May 6, 2022
ed2a097
Improve names a little bit more.
carlosalberto May 6, 2022
5c81afe
Update specification/metrics/semantic_conventions/instrumentation/kaf…
carlosalberto May 6, 2022
b4c817c
Align table.
carlosalberto May 6, 2022
c9997c9
Merge branch 'main' into kafka-metrics-addition
reyang May 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions specification/metrics/semantic_conventions/instrumentation/kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Instrumenting Kafka

**Status**: [Experimental](../../../document-status.md)

This document defines how to apply semantic conventions when instrumenting Kafka.

<!-- toc -->

<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- tocstop -->

## Kafka Metrics

**Description:** General Kafka metrics.

| Name | Instrument | Value type | Unit | Unit ([UCUM](README.md#instrument-units)) | Description | Attribute Key | Attribute Values |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| ------------------------------------ | -------------------- | ---------- | ---- | ----------------------------------------- | -------------- | ------------- | ---------------- |
| kafka.message.count | Asynchronous Counter | Int64 | messages | `{messages}` | The number of messages received by the broker. | | |
| kafka.request.count | Asynchronous Counter | Int64 | requests | `{requests}` | The number of requests received by the broker. | `type` | `produce`, `fetch` |
| kafka.request.failed | Asynchronous Counter | Int64 | requests | `{requests}` | The number of requests to the broker resulting in a failure. | `type` | `produce`, `fetch` |
| kafka.request.time.total | Asynchronous Counter | Int64 | milliseconds | `ms` | The total time the broker has taken to service requests. | `type` | `Produce`, `FetchConsumer`, `FetchFollower` |
| kafka.request.time.50p | Asynchronous Gauge | Double | milliseconds | `ms` | The 50th percentile time the broker has taken to service requests. | `type` | `Produce`, `FetchConsumer`, `FetchFollower` |
| kafka.request.time.99p | Asynchronous Gauge | Double | milliseconds | `ms` | The 99th percentile time the broker has taken to service requests. | `type` | `Produce`, `FetchConsumer`, `FetchFollower` |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.request.queue | Asynchronous Gauge | Int64 | requests | `{requests}` | The number of requests in the request queue. | | |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.network.io | Asynchronous Counter | Int64 | bytes | `by` | The bytes received or sent by the broker. | `state` | `in`, `out` |
| kafka.purgatory.size | Asynchronous Gauge | Int64 | requests | `{requests}` | The number of requests waiting in the purgatory. | `type` | `produce`, `fetch` |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.partition.count | Asynchronous Gauge | Int64 | partitions | `{partitions}` | The number of partitions in the broker. | | |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.partition.offline | Asynchronous Gauge | Int64 | partitions | `{partitions}` | The number of offline partitions. | | |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.partition.under_replicated | Asynchronous Gauge | Int64 | partition | `{partitions}` | The number of under replicated partitions. | | |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.isr.operation.count | Asynchronous Counter | Int64 | operations | `{operations}` | The number of in-sync replica shrink and expand operations. | `operation` | `shrink`, `expand` |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.max.lag | Asynchronous Gauge | Int64 | messages | `{messages}` | Max lag in messages between follower and leader replicas. | | |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.controller.active.count | Asynchronous Gauge | Int64 | controllers | `{controllers}` | Number of active controllers in the broker. | | |
carlosalberto marked this conversation as resolved.
Show resolved Hide resolved
| kafka.leader.election.rate | Asynchronous Counter | Int64 | elections | `{elections}` | Leader election rate (increasing values indicates broker failures). | | |
reyang marked this conversation as resolved.
Show resolved Hide resolved
| kafka.unclean.election.rate | Asynchronous Counter | Int64 | elections | `{elections}` | Unclean leader election rate (increasing values indicates broker failures). | | |
reyang marked this conversation as resolved.
Show resolved Hide resolved
| kafka.logs.flush.time.count | Asynchronous Counter | Int64 | milliseconds | `ms` | The time it has taken to flush logs. | | |
| kafka.logs.flush.time.50th | Asynchronous Gauge | Double | milliseconds | `ms` | The 50th percentile time it has taken to flush logs. | | |
| kafka.logs.flush.time.99th | Asynchronous Gauge | Double | milliseconds | `ms` | The 99th percentile time it has taken to flush logs. | | |
jmacd marked this conversation as resolved.
Show resolved Hide resolved

## Kafka Producer Metrics

**Description:** Kafka Producer level metrics.

| Name | Instrument | Value type | Unit | Unit ([UCUM](README.md#instrument-units)) | Description | Attribute Key | Attribute Values |
| ------------------------------------ | ------------------ | ---------- | ---- | ----------------------------------------- | -------------- | ------------- | ---------------- |
| kafka.producer.io-wait-time-ns-avg | Asynchronous Gauge | Double | nanoseconds | `ns` | The average length of time the I/O thread spent waiting for a socket ready for reads or writes. | client-id | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.producer.outgoing-byte-rate | Asynchronous Gauge | Double | bytes | `by`| The average number of outgoing bytes sent per second to all servers. | `client-id` | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.producer.request-latency-avg | Asynchronous Gauge | Double | milliseconds | `ms` | The average request latency. | `client-id` | `client-id` value |
| kafka.producer.request-rate | Asynchronous Gauge | Double | requests | `{requests}` | The average number of requests sent per second. | `client-id` | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.producer.response-rate | Asynchronous Gauge | Double | responses | `{responses}` | Responses received per second. | `client-id` | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| kafka.producer.byte-rate | Asynchronous Gauge | Double | bytes | `by` | The average number of bytes sent per second for a specific topic. | `client-id` | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| | | | | | | `topic` | topic name |
| kafka.producer.compression-rate | Asynchronous Gauge | Double | compression rate | `{compressionrate}` | The average compression rate of record batches for a specific topic. | `client-id` | `client-id` value |
jmacd marked this conversation as resolved.
Show resolved Hide resolved
| | | | | | | `topic` | topic name |
| kafka.producer.record-error-rate | Asynchronous Gauge | Double | error rate | `{errorrate}` | The average per-second number of record sends that resulted in errors for a specific topic. | `client-id` | `client-id` value |
| | | | | | | `topic` | topic name |
| kafka.producer.record-retry-rate | Asynchronous Gauge | Double | retry rate | `{retryrate}` | The average per-second number of retried record sends for a specific topic. | `client-id` | `client-id` value |
| | | | | | | `topic` | topic name |
| kafka.producer.record-send-rate | Asynchronous Gauge | Double | records sent rate | `{recordssentrate}` | The average number of records sent per second for a specific topic. | `client-id` | `client-id` value |
| | | | | | | `topic` | topic name |
jmacd marked this conversation as resolved.
Show resolved Hide resolved