Kubernetes Controller Manager 🔗

Description 🔗

Note: This monitor is deprecated in favor of the prometheus-exporter monitor. Switch to the Prometheus Exporter as the Smart Agent is deprecated. All Prometheus labels are converted directly to Infrastructure Monitoring dimensions. To learn more, see Prometheus Exporter.

The Splunk Distribution of OpenTelemetry Collector provides this integration as the kube-controller-manager monitor for the Smart Agent Receiver.

Use this integration to export Prometheus metrics from the kube-controller-manager.

The monitor queries path /metrics by default when no path is configured. The monitor converts the Prometheus metric types to Splunk Observability Cloud metric types as described in the documentation for prometheus-exporter.

Note: All metrics of this monitor are non-default and are only emitted if specified explicitly.

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.

Configuration example 🔗

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/kube-controller-manager:
    type: kube-controller-manager
    ... # Additional config

To complete the monitor activation, you must also include the smartagent/kube-controller-manager receiver item in a metrics pipeline. To do this, add the receiver item to the service/pipelines/metrics/receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/kube-controller-manager]

See configuration examples for specific use cases that show how the Splunk Distribution of OpenTelemetry Collector can integrate and complement existing environments.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option	Required	Type	Description
`httpTimeout`	no	`int64`	HTTP timeout duration for both read and writes. This should be a duration string that is accepted by https://golang.org/pkg/time/#ParseDuration (default: `10s`)
`username`	no	`string`	Basic Auth username to use on each request, if any.
`password`	no	`string`	Basic Auth password to use on each request, if any.
`useHTTPS`	no	`bool`	If `true`, the agent will connect to the server using HTTPS instead of plain HTTP. (default: `false`)
`httpHeaders`	no	`map of strings`	A map of HTTP header names to values. Comma separated multiple values for the same message-header is supported.
`skipVerify`	no	`bool`	If useHTTPS is `true` and this option is also `true`, the exporter’s TLS cert will not be verified. (default: `false`)
`caCertPath`	no	`string`	Path to the CA cert that has signed the TLS cert, unnecessary if `skipVerify` is set to `false`.
`clientCertPath`	no	`string`	Path to the client TLS cert to use for TLS required connections
`clientKeyPath`	no	`string`	Path to the client TLS key to use for TLS required connections
`host`	yes	`string`	Host of the exporter
`port`	yes	`integer`	Port of the exporter
`useServiceAccount`	no	`bool`	Use pod service account to authenticate. (default: `false`)
`metricPath`	no	`string`	Path to the metrics endpoint on the exporter server, usually `/metrics` (the default). (default: `/metrics`)
`sendAllMetrics`	no	`bool`	Send all the metrics that come out of the Prometheus exporter without any filtering. This option has no effect when using the Prometheus exporter monitor directly since there is no built-in filtering, only when embedding it in other monitors. (default: `false`)

Sample YAML configurations 🔗

The following is an example configuration of this monitor:

monitors:
- type: kube-controller-manager
  discoveryRule: kubernetes_pod_name =~ "kube-controller-manager" && target == "pod"
  port: 10252
  extraDimensions:
    metric_source: kubernetes-controller-manager

Metrics 🔗

These 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