Skip to content

Commit adb48be

Browse files
author
Kalyani Desai
committed
SRVKE-1275-Serverless: Added all the metrics tables in the Knative Eventing metrics section
1 parent 2e543df commit adb48be

7 files changed

+352
-3
lines changed

‎modules/serverless-knative-kafka-broker-metrics.adoc

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-broker-metrics_{context}"]
7+
= Knative Kafka broker metrics
8+
9+
You can use the following metrics to debug and visualize the performance of Kafka broker.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-broker-receiver-sm-service", namespace="knative-eventing"}`
20+
|Number of events received by a broker
21+
|Counter
22+
a|
23+
`name`:: broker name
24+
`namespace_name`:: broker namespace
25+
`event_type`:: event type
26+
`response_code`:: HTTP response code returned by the broker
27+
`response_code_class`:: HTTP response code class returned by the broker: 2xx, 3xx, 4xx, 5xx
28+
|Dimensionless
29+
30+
|`event_dispatch_latencies_ms_bucket{job="kafka-broker-receiver-sm-service", namespace="knative-eventing"}`
31+
|The time spent dispatching an event to a Kafka cluster
32+
|Histogram
33+
a|
34+
`name`:: broker name
35+
`namespace_name`:: broker namespace
36+
`event_type`:: event type
37+
`response_code`:: HTTP response code returned by the broker
38+
`response_code_class`:: HTTP response code class returned by the broker: 2xx, 3xx, 4xx, 5xx
39+
|Milliseconds
40+
41+
|`kafka_broker_controller_consumer_group_expected_replicas`
42+
|Number of expected replicas for a given Kafka consumer group resource
43+
|Gauge
44+
a|
45+
`consumer_name`:: resource name
46+
`namespace_name`:: resource namespace
47+
`consumer_kind`:: resource Kind, enum: `KafkaSource`, `Trigger`, `Subscription`
48+
49+
[NOTE]
50+
====
51+
In this context, resources refer to user facing entities such as Kafka source, trigger, and subscription. Avoid using internal or generated names when using these resources.
52+
====
53+
54+
|Dimensionless
55+
56+
|`kafka_broker_controller_consumer_group_ready_replicas`
57+
|Number of ready replicas for a given Kafka consumer group resource
58+
|Gauge
59+
a|
60+
`consumer_name`:: resource name
61+
`namespace_name`:: resource namespace
62+
`consumer_kind`:: resource Kind, enum: `KafkaSource`, `Trigger`, `Subscription`
63+
64+
[NOTE]
65+
====
66+
In this context, resources refer to user facing entities such as Kafka source, trigger, and subscription. Avoid using internal or generated names when using these resources.
67+
====
68+
69+
|Dimensionless
70+
71+
|===

‎modules/serverless-knative-kafka-channel-metrics.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-channel-metrics_{context}"]
7+
= Knative Kafka channel metrics
8+
9+
You can use the following metrics to debug and visualize the performance of Kafka channel.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-channel-receiver-sm-service", namespace="knative-eventing"}`
20+
|Number of events received by a Kafka channel
21+
|Counter
22+
a|
23+
`name`:: Kafka channel name
24+
`namespace_name`:: Kafka channel namespace
25+
`event_type`:: event type
26+
`response_code`:: HTTP response code returned by the Kafka channel
27+
`response_code_class`:: HTTP response code class returned by the Kafka channel: 2xx, 3xx, 4xx, 5xx
28+
|Dimensionless
29+
30+
|`event_dispatch_latencies_ms_bucket{job="kafka-channel-receiver-sm-service", namespace="knative-eventing"}`
31+
|The time spent dispatching an event to a Kafka cluster
32+
|Histogram
33+
a|
34+
`name`:: Kafka channel name
35+
`namespace_name`:: Kafka channel namespace
36+
`event_type`:: event type
37+
`response_code`:: HTTP response code returned by the Kafka channel
38+
`response_code_class`:: HTTP response code class returned by the Kafka channel: 2xx, 3xx, 4xx, 5xx
39+
|Milliseconds
40+
41+
|===

‎modules/serverless-knative-kafka-sink-metrics.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-sink-metrics_{context}"]
7+
= Knative Kafka sink metrics
8+
9+
You can use the following metrics to debug and visualize the performance of Kafka sinks.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-sink-receiver-sm-service", namespace="knative-eventing"}`
20+
|Number of events received by a broker
21+
|Counter
22+
a|
23+
`name`:: Kafka sink name
24+
`namespace_name`:: Kafka sink namespace
25+
`event_type`:: event type
26+
`response_code`:: HTTP response code returned by the Kafka sink
27+
`response_code_class`:: HTTP response code class returned by the Kafka sink: 2xx, 3xx, 4xx, 5xx
28+
|Dimensionless
29+
30+
|`event_dispatch_latencies_ms_bucket{job="kafka-sink-receiver-sm-service", namespace="knative-eventing"}`
31+
|The time spent dispatching an event to a Kafka cluster
32+
|Histogram
33+
a|
34+
`name`:: Kafka sink name
35+
`namespace_name`:: Kafka sink namespace
36+
`event_type`:: event type
37+
`response_code`:: HTTP response code returned by the Kafka sink
38+
`response_code_class`:: HTTP response code class returned by the Kafka sink: 2xx, 3xx, 4xx, 5xx
39+
|Milliseconds
40+
41+
|===

‎modules/serverless-knative-kafka-source-metrics.adoc

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-source-metrics_{context}"]
7+
= Knative Kafka source metrics
8+
9+
You can use the following metrics to debug and visualize the performance of Kafka sources.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`
20+
|Number of events dispatched by a Kafka source
21+
|Counter
22+
a|
23+
`consumer_name`:: Kafka source name
24+
`namespace_name`:: Kafka source namespace
25+
`name`:: Kafka source name
26+
`event_type`:: event type
27+
`response_code`:: HTTP response code returned by the Kafka source sink service
28+
`response_code_class`:: HTTP response code class returned by the Kafka source sink service: 2xx, 3xx, 4xx, 5xx
29+
|Dimensionless
30+
31+
|`event_dispatch_latencies_ms_bucket{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`
32+
|The time spent dispatching an event to a sink
33+
|Histogram
34+
a|
35+
`consumer_name`:: Kafka source name
36+
`namespace_name`:: Kafka source namespace
37+
`name`:: Kafka source name
38+
`event_type`:: event type
39+
`response_code`:: HTTP response code returned by the Kafka source sink service
40+
`response_code_class`:: HTTP response code class returned by the Kafka source sink service: 2xx, 3xx, 4xx, 5xx
41+
|Milliseconds
42+
43+
|`event_processing_latencies_ms_bucket{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`
44+
|The time spent processing an event
45+
|Histogram
46+
a|
47+
`consumer_name`:: Kafka source name
48+
`namespace_name`:: Kafka source namespace
49+
`name`:: Kafka source name
50+
`event_type`:: event type
51+
|Milliseconds
52+
53+
|`kafka_broker_controller_consumer_group_expected_replicas`
54+
|Number of expected replicas for a given Kafka consumer group resource
55+
|Gauge
56+
a|
57+
`consumer_name`:: resource name
58+
`namespace_name`:: resource namespace
59+
`consumer_kind`:: resource Kind, enum: `KafkaSource`, `Trigger`, `Subscription`
60+
61+
[NOTE]
62+
====
63+
In this context, resources refer to user facing entities such as Kafka source,trigger, and subscription. Avoid using internal or generated names when using these resources.
64+
====
65+
66+
|Dimensionless
67+
68+
|`kafka_broker_controller_consumer_group_ready_replicas`
69+
|Number of ready replicas for a given Kafka consumer group resource
70+
|Gauge
71+
a|
72+
`consumer_name`:: resource name
73+
`namespace_name`:: resource namespace
74+
`consumer_kind`:: resource Kind, enum: `KafkaSource`, `Trigger`, `Subscription`
75+
76+
[NOTE]
77+
====
78+
In this context, resources refer to user facing entities such as Kafka source,trigger, and subscription. Avoid using internal or generated names when using these resources.
79+
====
80+
81+
|Dimensionless
82+
83+
|===

‎modules/serverless-knative-kafka-subscription-metrics.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-subscription-metrics_{context}"]
7+
= Knative Kafka subscription metrics
8+
9+
You can use the following metrics to debug and visualize the performance of subscriptions associated with the Kafka channel.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`
20+
|Number of events dispatched by a subscription to a subscriber
21+
|Counter
22+
a|
23+
`consumer_name`:: Subscription name
24+
`namespace_name`:: Subscription namespace
25+
`name`:: KafkaChannel name
26+
`event_type`:: event type
27+
`response_code`:: HTTP response code returned by the `Subscription` subscriber service
28+
`response_code_class`:: HTTP response code class returned by the `Subscription` subscriber service: 2xx, 3xx, 4xx, 5xx
29+
|Dimensionless
30+
31+
|`event_dispatch_latencies_ms_bucket{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`
32+
|The time spent dispatching an event to a subscriber
33+
|Histogram
34+
a|
35+
`consumer_name`:: Subscription name
36+
`namespace_name`:: Subscription namespace
37+
`name`:: KafkaChannel name
38+
`event_type`:: event type
39+
`response_code`:: HTTP response code returned by the `Subscription` subscriber service
40+
`response_code_class`:: HTTP response code class returned by the `Subscription` subscriber service: 2xx, 3xx, 4xx, 5xx
41+
|Milliseconds
42+
43+
|`event_processing_latencies_ms_bucket{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`
44+
|The time spent processing an event
45+
|Histogram
46+
a|
47+
`consumer_name`:: Subscription name
48+
`namespace_name`:: Subscription namespace
49+
`name`:: KafkaChannel name
50+
`event_type`:: event type
51+
|Dimensionless
52+
53+
|===

‎modules/serverless-knative-kafka-trigger-metrics.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * serverless/observability/admin-metrics/serverless-admin-metrics.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="serverless-knative-kafka-trigger-metrics_{context}"]
7+
= Knative Kafka trigger metrics
8+
9+
You can use the following metrics to debug and visualize the performance of Kafka triggers.
10+
11+
[cols=5*,options="header"]
12+
|===
13+
|Metric name
14+
|Description
15+
|Type
16+
|Tags
17+
|Unit
18+
19+
|`event_count_1_total{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`
20+
|Number of events dispatched by a trigger to a subscriber
21+
|Counter
22+
a|
23+
`consumer_name`:: trigger name
24+
`namespace_name`:: trigger namespace
25+
`name`:: broker name
26+
`event_type`:: event type
27+
`response_code`:: HTTP response code returned by the trigger subscriber service
28+
`response_code_class`:: HTTP response code class returned by the trigger subscriber service: 2xx, 3xx, 4xx, 5xx
29+
|Dimensionless
30+
31+
|`event_dispatch_latencies_ms_bucket{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`
32+
|The time spent dispatching an event to a subscriber
33+
|Histogram
34+
a|
35+
`consumer_name`:: trigger name
36+
`namespace_name`:: trigger namespace
37+
`name`:: broker name
38+
`event_type`:: event type
39+
`response_code`:: HTTP response code returned by the trigger subscriber service
40+
`response_code_class`:: HTTP response code class returned by the trigger subscriber service: 2xx, 3xx, 4xx, 5xx
41+
|Milliseconds
42+
43+
|`event_processing_latencies_ms_bucket{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`
44+
|The time spent processing and filtering an event
45+
|Histogram
46+
a|
47+
`consumer_name`:: trigger name
48+
`namespace_name`:: trigger namespace
49+
`name`:: broker name
50+
`event_type`:: event type
51+
|Milliseconds
52+
53+
|===

‎observability/admin-metrics/serverless-admin-metrics-eventing.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
:_content-type: ASSEMBLY
2-
include::_attributes/common-attributes.adoc[]
1+
:_mod-docs-content-type: ASSEMBLY
32
[id="serverless-admin-metrics-eventing"]
43
= Knative Eventing metrics
4+
include::_attributes/common-attributes.adoc[]
55
:context: serverless-admin-metrics-eventing
66

77
toc::[]
@@ -13,4 +13,11 @@ By aggregating the metrics from HTTP code, events can be separated into two cate
1313
include::modules/serverless-broker-ingress-metrics.adoc[leveloffset=+1]
1414
include::modules/serverless-broker-filter-metrics.adoc[leveloffset=+1]
1515
include::modules/serverless-inmemory-dispatch-metrics.adoc[leveloffset=+1]
16-
include::modules/serverless-event-source-metrics.adoc[leveloffset=+1]
16+
include::modules/serverless-event-source-metrics.adoc[leveloffset=+1]
17+
18+
include::modules/serverless-knative-kafka-broker-metrics.adoc[leveloffset=+1]
19+
include::modules/serverless-knative-kafka-trigger-metrics.adoc[leveloffset=+1]
20+
include::modules/serverless-knative-kafka-channel-metrics.adoc[leveloffset=+1]
21+
include::modules/serverless-knative-kafka-subscription-metrics.adoc[leveloffset=+1]
22+
include::modules/serverless-knative-kafka-source-metrics.adoc[leveloffset=+1]
23+
include::modules/serverless-knative-kafka-sink-metrics.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)