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

Commit 3b48f21

Browse files
WIP
1 parent c09a96d commit 3b48f21

File tree

2 files changed

+26
-39
lines changed

2 files changed

+26
-39
lines changed

gdi/opentelemetry/collector-kubernetes/kubernetes-config-advanced.rst

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ This custom configuration is merged into the default agent configuration.
5757

5858
.. _otel-kubernetes-config-advanced-control-plane:
5959

60-
Override a control plane configuration
60+
Configure control plane metrics
6161
==============================================================
6262

63-
If any of the control plane metric receivers are activated under the ``agent.controlPlaneMetrics`` configuration section, then the Helm chart will configure the Collector to use the activated receivers to collect metrics from the control plane.
63+
Control plane metrics are available for the following components: ``coredns``, ``etcd``, ``kube-controller-manager``, ``kubernetes-apiserver``, ``kubernetes-proxy``, and ``kubernetes-scheduler``. You can use the :ref:`Collector Helm agent <helm-chart-components-agent>` to obtain control plane metrics from a specific component by setting ``agent.controlPlaneMetrics.{otel_component}`` to ``true``.
6464

65-
To collect control plane metrics, the Helm chart uses the Collector on each node to use the receiver creator to represent control plane receivers at runtime. The receiver creator has a set of discovery rules that know which control plane receivers to create. The default discovery rules can vary depending on the Kubernetes distribution and version. See :ref:`receiver-creator-receiver` for more information.
65+
The Helm chart uses the Collector on each node to use the receiver creator to represent control plane receivers at runtime. The receiver creator has a set of discovery rules that know which control plane receivers to create. The default discovery rules can vary depending on the Kubernetes distribution and version. See :ref:`receiver-creator-receiver` for more information.
6666

6767
If your control plane is using non-standard specifications, then you can provide a custom configuration to allow the Collector to successfully connect to it.
6868

69-
Availability and configuration instructions
69+
Supported versions
7070
-----------------------------------------------------------------------------
7171

7272
The Collector relies on pod-level network access to collect metrics from the control plane pods. Since most cloud Kubernetes as a service distributions don't expose the control plane pods to the end user, collecting metrics from these distributions is not supported.
@@ -90,7 +90,10 @@ The following table shows which Kubernetes distributions support control plane m
9090

9191
See the :new-page:`agent template <https://github.com/signalfx/splunk-otel-collector-chart/blob/main/helm-charts/splunk-otel-collector/templates/config/_otel-agent.tpl>` for the default configurations for the control plane receivers.
9292

93-
See the following documentation for information on the configuration options and supported metrics for each control plane receiver:
93+
Availability
94+
-----------------------------------------------------------------------------
95+
96+
The following components provide control plane metrics:
9497

9598
* :ref:`CoreDNS <coredns>`.
9699
* :ref:`etcd`. To retrieve etcd metrics, see :new-page:`Setting up etcd metrics <https://github.com/signalfx/splunk-otel-collector-chart/blob/main/docs/advanced-configuration.md#setting-up-etcd-metrics>`.
@@ -99,14 +102,6 @@ See the following documentation for information on the configuration options and
99102
* :ref:`Kubernetes proxy <kubernetes-proxy>`.
100103
* :ref:`Kubernetes scheduler <kubernetes-scheduler>`.
101104

102-
Known issue
103-
-----------------------------------------------------------------------------
104-
105-
There is a known limitation for the Kubernetes proxy control plane receiver. When using a Kubernetes cluster created using kops, a network connectivity issue prevents proxy metrics from being collected. The limitation can be addressed by updating the kubeProxy metric bind address in the kops cluster specification:
106-
107-
#. Set ``kubeProxy.metricsBindAddress: 0.0.0.0`` in the kops cluster specification.
108-
#. Run ``kops update cluster {cluster_name}`` and ``kops rolling-update cluster {cluster_name}`` to deploy the change.
109-
110105
Use custom configurations for non-standard control plane components
111106
-----------------------------------------------------------------------------
112107

@@ -135,6 +130,24 @@ The following example shows how to connect to a nonstandard API server that uses
135130
useHTTPS: true
136131
useServiceAccount: false
137132
133+
Activate control plane metrics histograms
134+
-------------------------------------------
135+
136+
To activate control plane metrics histograms, use the feature flag ``useControlPlaneMetricsHistogramData``, for example:
137+
138+
.. code-block:: yaml
139+
140+
featureGates:
141+
useControlPlaneMetricsHistogramData: true
142+
143+
Known issues
144+
-----------------------------------------------------------------------------
145+
146+
There is a known limitation for the Kubernetes proxy control plane receiver. When using a Kubernetes cluster created using kops, a network connectivity issue prevents proxy metrics from being collected. The limitation can be addressed by updating the kubeProxy metric bind address in the kops cluster specification:
147+
148+
#. Set ``kubeProxy.metricsBindAddress: 0.0.0.0`` in the kops cluster specification.
149+
#. Run ``kops update cluster {cluster_name}`` and ``kops rolling-update cluster {cluster_name}`` to deploy the change.
150+
138151
.. _kubernetes-config-advanced-non-root:
139152

140153
Run the container in non-root user mode

gdi/opentelemetry/collector-kubernetes/kubernetes-config.rst

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -210,32 +210,6 @@ Set ``agent.hostNetwork`` to ``false`` to turn off host network access. This mig
210210

211211
This value is disregarded for Windows.
212212

213-
.. _otel-kubernetes-config-control-plane-metrics:
214-
215-
Collect control plane metrics from specific OTel components
216-
======================================================================================
217-
218-
Control plane metrics are available for the following components: ``coredns``, ``etcd``, ``kube-controller-manager``, ``kubernetes-apiserver``, ``kubernetes-proxy``, and ``kubernetes-scheduler``
219-
220-
You can use the :ref:`Collector agent <helm-chart-components-agent>` to obtain control plane metrics from a specific component by setting ``agent.controlPlaneMetrics.{otel_component}`` to ``true``.
221-
222-
Supported distributions
223-
-------------------------------------------
224-
225-
Control plane metrics are supported for Kubernetes version 1.22 and Openshift version 4.9.
226-
227-
Unsupported distributions include AKS, EKS, EKS/Fargate, GKE, and GKE/Autopilot.
228-
229-
Activate control plane metrics histograms
230-
-------------------------------------------
231-
232-
To activate control plane metrics histograms, use the feature flag ``useControlPlaneMetricsHistogramData``, for example:
233-
234-
.. code-block:: yaml
235-
236-
featureGates:
237-
useControlPlaneMetricsHistogramData: true
238-
239213
Activate AlwaysOn Profiling
240214
=================================
241215

0 commit comments

Comments
 (0)