Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 2033c99

Browse files
Merge pull request #2032 from splunk/urbiz-DG25571-kbs-ootb-metrics
[DG25571]: Adding extra OOTB Collector metrics
2 parents c6f3b58 + d1d267a commit 2033c99

File tree

2 files changed

+155
-4
lines changed

2 files changed

+155
-4
lines changed

gdi/opentelemetry/collector-kubernetes/metrics-ootb-k8s.rst

Lines changed: 154 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@ Learn more about the Collector's configuration and data processing at:
1919
* :ref:`otel-data-processing`
2020
* :ref:`signalfx-exporter`
2121

22-
.. note:: In addition to the metrics shown on this page, most instances also send metrics from the :ref:`kubernetes-cluster-receiver`. Cluster Receiver metrics are an important part of monitoring any kubernets installation. Refer to that page as well as the metrics listed here.
23-
24-
To see the Collector's internal metrics, refer to :ref:`metrics-internal-collector`.
22+
.. note::
23+
24+
In addition to the metrics shown on this page, most Collector instances also send metrics from the :ref:`kubernetes-cluster-receiver`, which are an important part of monitoring any Kubernetes installation. Refer to that page as well as the metrics listed here.
25+
26+
For the Collector's internal metrics, see :ref:`metrics-internal-collector`.
2527

2628
Container level metrics and dimensions
2729
============================================================================
@@ -121,6 +123,18 @@ Container level metrics and dimensions
121123
- No
122124
- Yes
123125

126+
* - ``k8s.container.ephemeralstorage_limit``
127+
- Container ``ephemeralstorage_limit``
128+
- :ref:`ootb-metrics-k8s-attributes`
129+
- No
130+
- No
131+
132+
* - ``k8s.container.ephemeralstorage_request``
133+
- Container ``ephemeralstorage_request``
134+
- :ref:`ootb-metrics-k8s-attributes`
135+
- No
136+
- No
137+
124138
* - ``k8s.container.memory_limit``
125139
- Container ``memory_limit``
126140
- :ref:`ootb-metrics-k8s-attributes`
@@ -133,6 +147,24 @@ Container level metrics and dimensions
133147
- No
134148
- Yes
135149

150+
* - ``k8s.container.restarts``
151+
- Container ``restarts``
152+
- :ref:`ootb-metrics-k8s-attributes`
153+
- No
154+
- Yes
155+
156+
* - ``k8s.container.storage_limit``
157+
- Container ``storage_limit``
158+
- :ref:`ootb-metrics-k8s-attributes`
159+
- No
160+
- No
161+
162+
* - ``k8s.container.storage_request``
163+
- Container ``storage_requests``
164+
- :ref:`ootb-metrics-k8s-attributes`
165+
- No
166+
- No
167+
136168
Pod level metrics and dimensions
137169
============================================================================
138170

@@ -219,6 +251,11 @@ Pod level metrics and dimensions
219251
* :ref:`ootb-metrics-k8s-attributes`
220252
- Yes
221253

254+
* - ``k8s.pod.status_reason``
255+
- Information on the pod status
256+
-
257+
- Yes
258+
222259
Node level metrics and dimensions
223260
============================================================================
224261

@@ -238,6 +275,11 @@ Node level metrics and dimensions
238275
- Attributes
239276
- Exported?
240277

278+
* - ``k8s.node.condition``
279+
- Node condition
280+
-
281+
- No
282+
241283
* - ``k8s.node.cpu.time``
242284
- Node CPU time
243285
-
@@ -524,6 +566,115 @@ The following distributions support control plane metrics configuration:
524566

525567
For information about control plane metrics, see :ref:`otel-kubernetes-config-advanced-control-plane`.
526568

569+
.. _ootb-metrics-k8s-other:
570+
571+
Other metrics
572+
============================================================================
573+
574+
.. caution::
575+
576+
The :strong:`Exported?` column indicates if the metric is finally sent to Splunk Observability Cloud after going through the Collector pipelines.
577+
578+
Other available metrics include:
579+
580+
.. list-table::
581+
:widths: 75 25
582+
:width: 100%
583+
:header-rows: 1
584+
585+
* - Metric name
586+
- Exported?
587+
588+
* - ``k8s.deployment.desired``
589+
- Yes
590+
591+
* - ``k8s.deployment.available``
592+
- Yes
593+
594+
* - ``k8s.daemonset.current_scheduled_nodes``
595+
- Yes
596+
597+
* - ``k8s.daemonset.current_scheduled_nodes``
598+
- Yes
599+
600+
* - ``k8s.daemonset.misscheduled_nodes``
601+
- Yes
602+
603+
* - ``k8s.daemonset.ready_nodes``
604+
- Yes
605+
606+
* - ``k8s.hpa.max_replicas``
607+
- No
608+
609+
* - ``k8s.hpa.min_replicas``
610+
- No
611+
612+
* - ``k8s.hpa.current_replicas``
613+
- No
614+
615+
* - ``k8s.hpa.desired_replicas``
616+
- No
617+
618+
* - ``k8s.job.active_pods``
619+
- No
620+
621+
* - ``k8s.job.desired_successful_pods``
622+
- No
623+
624+
* - ``k8s.job.failed_pods``
625+
- No
626+
627+
* - ``k8s.job.max_parallel_pods``
628+
- No
629+
630+
* - ``k8s.job.successful_pods``
631+
- No
632+
633+
* - ``k8s.namespace.phase``
634+
- Yes
635+
636+
* - ``k8s.replicaset.desired``
637+
- Yes
638+
639+
* - ``k8s.replicaset.available``
640+
- Yes
641+
642+
* - ``k8s.replication_controller.desired``
643+
- Yes
644+
645+
* - ``k8s.replication_controller.available``
646+
- Yes
647+
648+
* - ``k8s.resource_quota.hard_limit``
649+
- Yes
650+
651+
* - ``k8s.resource_quota.used``
652+
- Yes
653+
654+
* - ``k8s.statefulset.desired_pods``
655+
- No
656+
657+
* - ``k8s.statefulset.ready_pods``
658+
- No
659+
660+
* - ``k8s.statefulset.current_pods``
661+
- No
662+
663+
* - ``k8s.statefulset.updated_pods``
664+
- No
665+
666+
* - ``openshift.clusterquota.limit``
667+
- Yes
668+
669+
* - ``openshift.clusterquota.used``
670+
- Yes
671+
672+
* - ``openshift.appliedclusterquota.limit``
673+
- Yes
674+
675+
* - ``openshift.appliedclusterquota.used``
676+
- Yes
677+
527678
.. _ootb-metrics-k8s-attributes:
528679

529680
Standard resource dimensions

gdi/opentelemetry/components/kubernetes-cluster-receiver.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Kubernetes version 1.21 and higher is compatible with the Kubernetes navigator.
1616
Get started
1717
======================
1818

19-
By default, the Kubernetes cluster receiver is already activated in the Helm chart of the Splunk OpenTelemetry Collectors. See :ref:`otel-kubernetes-config` for more information.
19+
By default, the Kubernetes cluster receiver is already activated in the Helm chart of the Splunk OpenTelemetry Collectors. See :ref:`otel-kubernetes-config` for more information, including the default :ref:`ootb-metrics-k8s`.
2020

2121
To activate the Kubernetes cluster receiver manually in the Collector configuration, add ``k8s_cluster`` to the ``receivers`` section of your configuration file, as shown in the following example:
2222

0 commit comments

Comments
 (0)