Docs » Configure application receivers » Configure application receivers for orchestration » Kubernetes API server

Kubernetes API server 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the kubernetes-apiserver monitor by using the SignalFx Smart Agent Receiver.

Use this integration to retrieve metrics from the API server’s Prometheus metric endpoint.

This monitor is available on Kubernetes, Linux, and Windows.

Benefits 🔗

After you’ve configured the integration, you can:

  • View metrics using the built-in dashboard. 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 Metric Finder and search for metrics sent by the monitor. For information about Metric Finder, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy the integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:

  2. Configure the monitor, as described in the next section.

  3. Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

This monitor is available in the Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector. The Smart Agent Receiver allows you to use existing Smart Agent monitors as OpenTelemetry Collector metric receivers.

Using this monitor assumes that you have a properly configured environment with a functional Smart Agent release bundle on your system, which is already provided for x86_64/amd64 Splunk Distribution of OpenTelemetry Collector installation paths.

To activate this monitor in the Splunk Distribution of OpenTelemetry Collector, add the following to your configuration (YAML) file:

    type: kubernetes-apiserver
    ... # Additional config

To complete the monitor activation, you must also include the monitor in a metrics pipeline. To do this, add the monitor to the service > pipelines > metrics > receivers section of your configuration file. For example:

      receivers: [kubernetes-apiserver]

Usage 🔗

Use this integration to:

  • Query the Kubernetes API server for kube-apiserver metrics in Prometheus format

  • Query path /metrics by default when no path is configured. Use the metricPath configuration option to change the endpoint on the exporter server.

See the kubernetes-yaml examples in GitHub for the Agent and Gateway YAML files.

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 (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)

Example configuration 🔗

The following is an example YAML configuration:

    type: kubernetes-apiserver
      metric_source: kubernetes-apiserver
  discoveryRule: Get(container_labels, "component") == "kube-apiserver"
    metric_source: kubernetes-apiserver

The OpenTelemetry Collector has a Kubernetes observer (k8sobserver) that can be implemented as an extension to discover networked endpoints, such as a Kubernetes pod. Using this observer assumes that the OpenTelemetry Collector is deployed in Agent mode, where it is running on each individual node or host instance.

To use the observer, you must create a receiver creator instance with an associated rule. For example:

  # Configures the Kubernetes observer to watch for pod start and stop events.

    # Name of the extensions to watch for endpoints to start and stop.
    watch_observers: [k8s_observer]
        # Configure prometheus scraping if standard prometheus annotations are set on the pod.
        rule: type == "pod" && annotations[""] == "true"
          metrics_path: '`"" in annotations ? annotations[""] : "/metrics"`'
          endpoint: '`endpoint`:`"" in annotations ? annotations[""] : 9090`'

        # If this rule matches an instance of this receiver will be started.
        rule: type == "port" && port == 6379
          # Static receiver-specific config.
          password: secret
          # Dynamic configuration value.
          collection_interval: `pod.annotations["collection_interval"]`
          # Dynamic configuration value.

        # Set a resource attribute based on endpoint value.
        rule: type == "port" && port == 6379
          # Dynamic value.
          app: `pod.labels["app"]`
          # Static value.
          source: redis
    # Name of the extensions to watch for endpoints to start and stop.
    watch_observers: [host_observer]
        # If this rule matches, an instance of this receiver is started.
        rule: type == "port" && port == 6379 && is_ipv6 == true



      receivers: [receiver_creator/1, receiver_creator/2]
      processors: [exampleprocessor]
      exporters: [exampleexporter]
  extensions: [k8s_observer, host_observer]

Metrics 🔗

These are the metrics available for this integration.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud: