Kubernetes cluster receiver π
The Kubernetes cluster receiver collects cluster metrics using the Kubernetes API server. You can use a single instance of this receiver to monitor an entire Kubernetes cluster. The supported pipeline type is metrics
. See Configure pipelines for more information.
Kubernetes version 1.21 and higher is compatible with the Kubernetes navigator. Using lower versions of Kubernetes is not supported for this receiver and might result in the navigator not displaying all clusters.
Note
This receiver replaces the kubernetes-cluster
Smart Agent monitor type.
Get started π
By default, the Kubernetes cluster receiver is already activated in the Helm chart of the Splunk OpenTelemetry Collectors. See Configure Helm for Kubernetes for more information.
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:
receivers:
k8s_cluster:
auth_type: kubeConfig
collection_interval: 30s
node_conditions_to_report: ["Ready", "MemoryPressure"]
allocatable_types_to_report: ["cpu","memory"]
metadata_exporters: [signalfx]
To complete the configuration, include the receiver in the metrics
pipeline of the service
section of your
configuration file. For example:
service:
pipelines:
metrics:
receivers: [k8s_cluster]
Sync metadata_exporters π
Use metadata_exporters
as a list of metadata exporters to sync with metadata collected by the Kubernetes cluster receiver. For example:
receivers:
k8s_cluster:
auth_type: serviceAccount
metadata_exporters:
- signalfx
Exporters specified in this list need to implement the following interface. If an exporter doesnβt implement the interface, startup fails.
type MetadataExporter interface {
ConsumeMetadata(metadata []*MetadataUpdate) error
}
type MetadataUpdate struct {
ResourceIDKey string
ResourceID ResourceID
MetadataDelta
}
type MetadataDelta struct {
MetadataToAdd map[string]string
MetadataToRemove map[string]string
MetadataToUpdate map[string]string
}
Set node_conditions_to_report π
Use the following configuration to have the k8s_cluster
receiver emit two metrics, k8s.node.condition_ready
and k8s.node.condition_memory_pressure
, one for each condition in the configuration:
# ...
k8s_cluster:
node_conditions_to_report:
- Ready
- MemoryPressure
# ...
The value is 1
if the ConditionStatus
for the corresponding Condition
is True
, 0
if itβs False
, and -1
if itβs Unknown
. To learn more, search for βConditionsβ in the Kubernetes documentation.
Settings π
The following table shows the configuration options for the MongoDB Atlas:
Metrics π
The following table shows the legacy metrics that are available for this integration. See Mapping service and mapping report for the Splunk Distribution of OpenTelemetry Collector equivalents.
Note
The SignalFx exporter excludes some available metrics by default. Learn more about default metric filters in List of metrics excluded by default.
Troubleshooting π
If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.
Available to Splunk Observability Cloud customers π
Submit a case in the Splunk Support Portal.
Call Splunk Customer Support.
Available to customers and free trial users π
Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.
To learn about even more support options, see Splunk Customer Success.