Kubernetes cluster (deprecated)

Use this Splunk Observability Cloud integration for the Kubernetes cluster monitor. See benefits, install, configuration, and metrics

This monitor is deprecated in favor of the native OpenTelemetry component k8s_cluster receiver. See Kubernetes Cluster Receiver for more information. If you are using OpenShift, use the openshift-cluster monitor type instead.

Configuration settings

The following tables show the configuration options for this monitor type:

Option

Required

Type

Description

alwaysClusterReporter

no

bool

If true, leader election is skipped and metrics are always

reported. Default is false.

namespace

no

string

If specified, only resources within the given namespace will be

monitored. If omitted (blank), all supported resources across all namespaces will be monitored.

kubernetesAPI

no

object (see below)

Configuration for the Kubernetes API client

nodeConditionTypesToReport

no

list of strings

A list of node status condition types to report as metrics. The

metrics will be reported as data points of the form kubernetes.node_<type_snake_cased> with a value of 0 corresponding to "False", 1 to "True", and -1 to "Unknown". Default is [Ready].

The nested kubernetesAPI configuration object has the following fields:

Option

Required

Type

Description

authType

no

string

To authenticate to the K8s API server:

  • none for noauthentication.

  • tls to use manually specified TLS client certs (not recommended).

  • serviceAccount to use the standard service account token provided to the agent pod.

  • kubeConfig to use credentials from ~/.kube/config.

  • Default is serviceAccount.

skipVerify

no

bool

Whether to skip verifying the TLS cert from the API server.

Almost never needed. Default is false.

clientCertPath

no

string

The path to the TLS client cert on the pod’s filesystem, if

using tls authentication.

clientKeyPath

no

string

The path to the TLS client key on the pod’s filesystem, if using

tls authentication.

caCertPath

no

string

Path to a CA certificate to use when verifying the API server

TLS certificate. This is provided by Kubernetes alongside the service account token, which is picked up automatically. Specify this path in rare cases only.

Metrics

The following table shows the legacy metrics that are available for this integration.

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/kubernetes/cluster/metadata.yaml

Notes

  • To learn more about the available in Splunk Observability Cloud see Metric types.

  • In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.

  • In MTS-based subscription plans, all metrics are custom.

  • To add additional metrics, see how to configure extraMetrics in Add additional metrics.

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

Available to prospective 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.