Kubernetes network stats 🔗

Note

This monitor is deprecated in favor of the kubeletstats receiver. See Kubelet Stats Receiver for more information.

Description 🔗

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent Receiver to deploy the kubelet-stats monitor. This monitor pulls cadvisor metrics through a Kubernetes kubelet instance using the /stats/container endpoint.

Pause containers 🔗

Network stats for a Kubernetes pod are traditionally accounted for on the “pause” container, which is the container responsible for “owning” the network namespace that the other containers in the pod will use, among other things. Therefore, the network stats are usually zero for all non-pause containers and accounted for in an aggregated way using the pause container.

Since the only generally useful stats of the pause container are network stats, this monitor will omit non-network metrics for any containers named POD. This is the standard name for the “pause” container in Kubernetes when using the Docker runtime, but the pause container has no name under other runtimes. Therefore, you need to explicitly filter out non-network metrics from pause containers when using non-Docker runtimes. The following configuration will do that:

monitors:
- type: kubelet-stats
  datapointsToExclude:
  - dimensions:
      container_image:
       - '*pause-amd64*'
       - 'k8s.gcr.io/pause*'
    metricNames:
      - '*'
      - '!*network*'

If your deployment uses an image name for the pause container that does not fit the given patterns, you should change it to fit the pattern.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

This Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing a kubelet-stats monitor entry in your Collector or Smart Agent (deprecated) configuration is required for its use. Use the appropriate form for your agent type.

receivers:
  smartagent/kubelet-stats: 
    type: kubelet-stats
    ... # Additional config

To complete the integration, include the Smart Agent receiver using this monitor in a metrics pipeline. To do this, add the receiver to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/kubelet-stats]

Configuration settings 🔗

The following tables show the configuration options for this monitor:

Option	Required	Type	Description
`kubeletAPI`	no	`object` (see the following table)	Kubelet client configuration

The nested kubeletAPI configuration object has the following fields:

Option	Required	Type	Description
`url`	no	`string`	URL of the Kubelet instance. This will default to `http://<current node hostname>:10255` if not provided.
`authType`	no	`string`	Can be `none` for no auth, `tls` for TLS client cert auth, or `serviceAccount` to use the pod’s default service account token to authenticate. The default value is `none`.
`skipVerify`	no	`bool`	Whether to skip verification of the Kubelet TLS cert. The default value is `true`.
`caCertPath`	no	`string`	Path to the CA cert that has signed the Kubelet TLS cert, unnecessary if `skipVerify` is set to `false`.
`clientCertPath`	no	`string`	Path to the client TLS cert to use if `authType` is set to `tls`
`clientKeyPath`	no	`string`	Path to the client TLS key to use if `authType` is set to `tls`
`logResponses`	no	`bool`	Whether to log the raw cadvisor response at the debug level for debugging purposes. The default value is `false`.

Metrics 🔗

The following metrics are available for this integration:

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics