You are viewing docs on Elastic's new documentation system, currently in technical preview. For all other Elastic docs, visit elastic.co/guide.

Kube-scheduler Metrics

Collect metrics from Kubernetes Scheduler with Elastic Agent.

What is an Elastic integration?
Version
1.58.0 (View all)
Compatible Kibana version(s)
8.12.0 or higher
Supported Serverless project types

What's this?
Security
Observability
Subscription level
What's this?
Basic

Metrics

scheduler

This is the scheduler dataset of the Kubernetes package. It collects metrics from Kubernetes Scheduler component.

An example event for scheduler looks as following:

{
    "kubernetes": {
        "scheduler": {
            "name": "DynamicConfigMapCABundle-client-ca",
            "workqueue": {
                "retries": {
                    "count": 0
                },
                "depth": {
                    "count": 0
                },
                "unfinished": {
                    "sec": 0
                },
                "longestrunning": {
                    "sec": 0
                },
                "adds": {
                    "count": 12
                }
            }
        }
    },
    "orchestrator": {
        "cluster": {
            "name": "kind",
            "url": "kind-control-plane:6443"
        }
    },
    "agent": {
        "name": "kind-control-plane",
        "id": "ee1d778a-e607-4c29-b152-f6e83e606966",
        "type": "metricbeat",
        "ephemeral_id": "084bb5dd-df70-4127-9a52-47fae69de446",
        "version": "8.7.0"
    },
    "@timestamp": "2023-01-10T15:10:33.424Z",
    "ecs": {
        "version": "8.0.0"
    },
    "data_stream": {
        "namespace": "default",
        "type": "metrics",
        "dataset": "kubernetes.scheduler"
    },
    "service": {
        "address": "https://0.0.0.0:10259/metrics",
        "type": "kubernetes"
    },
    "elastic_agent": {
        "id": "ee1d778a-e607-4c29-b152-f6e83e606966",
        "version": "8.7.0",
        "snapshot": true
    },
    "host": {
        "hostname": "kind-control-plane",
        "os": {
            "kernel": "5.15.49-linuxkit",
            "codename": "focal",
            "name": "Ubuntu",
            "type": "linux",
            "family": "debian",
            "version": "20.04.5 LTS (Focal Fossa)",
            "platform": "ubuntu"
        },
        "ip": [
            "10.244.0.1",
            "10.244.0.1",
            "10.244.0.1",
            "172.20.0.2",
            "172.18.0.2",
            "fc00:f853:ccd:e793::2",
            "fe80::42:acff:fe12:2"
        ],
        "containerized": false,
        "name": "kind-control-plane",
        "id": "1c1d736687984c73b6a5f77c1464d4da",
        "mac": [
            "02-42-AC-12-00-02",
            "02-42-AC-14-00-02",
            "6E-87-97-B3-C4-A1",
            "7E-2B-73-DA-CF-B7",
            "F2-54-31-F4-76-AB"
        ],
        "architecture": "x86_64"
    },
    "metricset": {
        "period": 10000,
        "name": "scheduler"
    },
    "event": {
        "duration": 21808836,
        "agent_id_status": "verified",
        "ingested": "2023-01-10T15:10:37Z",
        "module": "kubernetes",
        "dataset": "kubernetes.scheduler"
    }
}

Exported fields

FieldDescriptionTypeUnitMetric Type
@timestamp
Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline. Required field for all events.
date
agent.id
Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id.
keyword
cloud.account.id
The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.
keyword
cloud.availability_zone
Availability zone in which this host, resource, or service is located.
keyword
cloud.image.id
Image ID for the cloud instance.
keyword
cloud.instance.id
Instance ID of the host machine.
keyword
cloud.instance.name
Instance name of the host machine.
keyword
cloud.machine.type
Machine type of the host machine.
keyword
cloud.project.id
The cloud project identifier. Examples: Google Cloud Project id, Azure Project id.
keyword
cloud.provider
Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.
keyword
cloud.region
Region in which this host, resource, or service is located.
keyword
container.id
Unique container id.
keyword
container.image.name
Name of the image the container was built on.
keyword
container.labels
Image labels.
object
container.name
Container name.
keyword
data_stream.dataset
The field can contain anything that makes sense to signify the source of the data. Examples include nginx.access, prometheus, endpoint etc. For data streams that otherwise fit, but that do not have dataset set we use the value "generic" for the dataset value. event.dataset should have the same value as data_stream.dataset. Beyond the Elasticsearch data stream naming criteria noted above, the dataset value has additional restrictions: * Must not contain - * No longer than 100 characters
constant_keyword
data_stream.namespace
A user defined namespace. Namespaces are useful to allow grouping of data. Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with default. If no value is used, it falls back to default. Beyond the Elasticsearch index naming criteria noted above, namespace value has the additional restrictions: * Must not contain - * No longer than 100 characters
constant_keyword
data_stream.type
An overarching type for the data stream. Currently allowed values are "logs" and "metrics". We expect to also add "traces" and "synthetics" in the near future.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
host.architecture
Operating system architecture.
keyword
host.containerized
If the host is a container.
boolean
host.domain
Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider.
keyword
host.hostname
Hostname of the host. It normally contains what the hostname command returns on the host machine.
keyword
host.id
Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name.
keyword
host.ip
Host ip addresses.
ip
host.mac
Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.
keyword
host.name
Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.
keyword
host.os.build
OS build information.
keyword
host.os.codename
OS codename, if any.
keyword
host.os.family
OS family (such as redhat, debian, freebsd, windows).
keyword
host.os.kernel
Operating system kernel version as a raw string.
keyword
host.os.name
Operating system name, without the version.
keyword
host.os.name.text
Multi-field of host.os.name.
match_only_text
host.os.platform
Operating system platform (such centos, ubuntu, windows).
keyword
host.os.version
Operating system version as a raw string.
keyword
host.type
Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment.
keyword
kubernetes.annotations.*
Kubernetes annotations map
object
kubernetes.container.image
Kubernetes container image
keyword
kubernetes.container.name
Kubernetes container name
keyword
kubernetes.deployment.name
Kubernetes deployment name
keyword
kubernetes.labels.*
Kubernetes labels map
object
kubernetes.namespace
Kubernetes namespace
keyword
kubernetes.node.hostname
Kubernetes hostname as reported by the node’s kernel
keyword
kubernetes.node.name
Kubernetes node name
keyword
kubernetes.pod.ip
Kubernetes pod IP
ip
kubernetes.pod.name
Kubernetes pod name
keyword
kubernetes.pod.uid
Kubernetes pod UID
keyword
kubernetes.replicaset.name
Kubernetes replicaset name
keyword
kubernetes.scheduler.client.request.count
Number of HTTP requests to API server, broken down by status code, method and host
long
counter
kubernetes.scheduler.client.request.duration.us.bucket.*
Requests latency distribution in histogram buckets, broken down by verb and host
object
kubernetes.scheduler.client.request.duration.us.count
Number of request duration operations to API server, broken down by verb and host
long
counter
kubernetes.scheduler.client.request.duration.us.sum
Sum of requests latency in microseconds, broken down by verb and host
long
micros
counter
kubernetes.scheduler.client.request.size.bytes.bucket.*
Requests size distribution in histogram buckets, broken down by verb and host
object
kubernetes.scheduler.client.request.size.bytes.count
Number of requests, broken down by verb and host
long
counter
kubernetes.scheduler.client.request.size.bytes.sum
Requests size sum in bytes, broken down by verb and host
long
byte
counter
kubernetes.scheduler.client.response.size.bytes.bucket.*
Responses size distribution in histogram buckets, broken down by verb and host
object
kubernetes.scheduler.client.response.size.bytes.count
Number of responses, broken down by verb and host
long
counter
kubernetes.scheduler.client.response.size.bytes.sum
Responses size sum in bytes, broken down by verb and host
long
byte
counter
kubernetes.scheduler.code
HTTP code
keyword
kubernetes.scheduler.event
Scheduling event
keyword
kubernetes.scheduler.host
HTTP host
keyword
kubernetes.scheduler.leader.is_master
Whether the scheduler instance is leader
boolean
kubernetes.scheduler.method
HTTP method
keyword
kubernetes.scheduler.name
Name for the resource
keyword
kubernetes.scheduler.process.cpu.sec
Total user and system CPU time spent in seconds
double
counter
kubernetes.scheduler.process.fds.max.count
Limit for open file descriptors
long
gauge
kubernetes.scheduler.process.fds.open.count
Number of open file descriptors
long
gauge
kubernetes.scheduler.process.memory.resident.bytes
Bytes in resident memory
long
byte
gauge
kubernetes.scheduler.process.memory.virtual.bytes
Bytes in virtual memory
long
byte
gauge
kubernetes.scheduler.process.started.sec
Start time of the process since unix epoch in seconds
double
gauge
kubernetes.scheduler.profile
Scheduling profile
keyword
kubernetes.scheduler.queue
Scheduling queue
keyword
kubernetes.scheduler.result
Attempt result to schedule pod
keyword
kubernetes.scheduler.scheduling.attempts.duration.us.bucket.*
Scheduling attempt latency distribution in histogram buckets, broken down by profile and result
object
kubernetes.scheduler.scheduling.attempts.duration.us.count
Number of scheduling attempts, broken down by profile and result
long
counter
kubernetes.scheduler.scheduling.attempts.duration.us.sum
Sum of scheduling attempt latency in microseconds, broken down by profile and result
long
micros
counter
kubernetes.scheduler.scheduling.pending.pods.count
Number of current pending pods, broken down by the queue type
long
gauge
kubernetes.scheduler.scheduling.preemption.attempts.count
Total preemption attempts in the cluster so far
long
counter
kubernetes.scheduler.scheduling.preemption.victims.bucket.*
Number of preemption victims distribution in histogram buckets
object
kubernetes.scheduler.scheduling.preemption.victims.count
Number of preemption victims
long
counter
kubernetes.scheduler.scheduling.preemption.victims.sum
Preemption victims sum
long
counter
kubernetes.scheduler.verb
HTTP verb
keyword
kubernetes.scheduler.workqueue.adds.count
Workqueue add count, broken down by workqueue name
long
counter
kubernetes.scheduler.workqueue.depth.count
Workqueue current depth, broken down by workqueue name
long
gauge
kubernetes.scheduler.workqueue.longestrunning.sec
How many seconds has the longest running processor been running, broken down by workqueue name
double
gauge
kubernetes.scheduler.workqueue.retries.count
Workqueue number of retries, broken down by workqueue name
long
counter
kubernetes.scheduler.workqueue.unfinished.sec
How many seconds of work has done that is in progress and hasn't been considered in the longest running processor, broken down by workqueue name
double
gauge
kubernetes.selectors.*
Kubernetes Service selectors map
object
kubernetes.statefulset.name
Kubernetes statefulset name
keyword
orchestrator.cluster.name
Name of the cluster.
keyword
orchestrator.cluster.url
URL of the API used to manage the cluster.
keyword
service.address
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).
keyword
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword

Changelog

VersionDetailsKibana version(s)

1.58.0

Enhancement View pull request
Migrate to format_version v3.

8.12.0 or higher

1.57.0

Enhancement View pull request
Container logs preserve original content based on pod annotations.

8.12.0 or higher

1.56.0

Enhancement View pull request
Add new fields to API server, state_node and persistent volume claim data streams.

8.12.0 or higher

1.55.1

Enhancement View pull request
Modify the field definitions to reference ECS.

8.11.0 or higher

1.55.0

Enhancement View pull request
Remove extra base fields from state data streams.

8.11.0 or higher

1.54.0

Enhancement View pull request
Expand condition support to remaining inputs

8.11.0 or higher

1.53.0

Enhancement View pull request
Update size of the metric visualizations

8.11.0 or higher

1.52.0

Enhancement View pull request
Add new data stream state_namespace.

8.11.0 or higher

1.51.0

Enhancement View pull request
Migrate Deployments dashboard visualizations to lens.

8.10.2 or higher

1.50.0

Enhancement View pull request
Migrate Cronjobs dashboard visualizations to lens

8.10.2 or higher

1.49.0

Enhancement View pull request
Migrate DaemonSets dashboard visualizations to lens.

8.10.2 or higher

1.48.0

Enhancement View pull request
Migrate StatefulSets dashboard visualizations to lens.

8.10.2 or higher

1.47.0

Enhancement View pull request
Migrate Jobs dashboard visualizations to lens.

8.10.2 or higher

1.46.0

Enhancement View pull request
Adapt fields for changes in file system info

8.10.1 or higher

1.45.0

Enhancement View pull request
Reroute container logs based on pod annotations.

8.10.0 or higher

1.44.0

Enhancement View pull request
Introducing kubernetes.deployment.status.* metrics

8.10.0 or higher

1.43.1

Enhancement View pull request
Updating index pattern for adHocDataviews for CCS use case

8.8.0 or higher

1.43.0

Enhancement View pull request
Expand index pattern for adHocDataviews for CCS use case

8.8.0 or higher

1.42.0

Enhancement View pull request
Add permissions to reroute events to logs-- for container_logs datastream

8.8.0 or higher

1.41.0

Enhancement View pull request
Enable time series data streams for the metrics datasets. This improves storage usage and query performance. For more details, see https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html

8.8.0 or higher

1.40.0

Bug fix View pull request
Fix system tests for kubernetes integration for k8s v1.27.0

8.8.0 or higher

1.40.0-beta.2

Bug fix View pull request
Fix volume dashboard.

—

1.40.0-beta.1

Bug fix View pull request
Fix proxy and scheduler visualization with missing sort field.

—

1.40.0-beta

Enhancement View pull request
Enable TSDS for metrics data_streams, except events for beta testing

—

1.39.0

Enhancement View pull request
Remove container.name as a dimension.

8.6.1 or higher

1.38.1

Enhancement View pull request
Switch max to last value on counter formulas and add missing sort field to proxy, controller manager and scheduler dashboard.

8.6.1 or higher

1.38.0

Enhancement View pull request
Fix Pod dashboard and remove some visualisations from Api Server dashboard to support TSDB migration

8.6.1 or higher

1.37.0

Enhancement View pull request
Update proxy, controller manager and scheduler dashboard to support TSDB.

8.6.1 or higher

1.36.0

Enhancement View pull request
Add container.name dimension to container data stream

8.6.1 or higher

1.35.0

Enhancement View pull request
Add NetworkUnavailable condition to state node

8.6.1 or higher

1.34.1

Enhancement View pull request
Add support for TSDB on all metric data streams except the state ones

8.6.1 or higher

1.34.0

Enhancement View pull request
Add support for TSDB on all state metric data streams

8.6.1 or higher

1.33.0

Enhancement View pull request
Add data_stream.dataset setting and custom yaml input.

8.6.1 or higher

1.32.2

Enhancement View pull request
Added link to docs for condition filter

8.6.1 or higher

1.32.1

Enhancement View pull request
Added categories and/or subcategories.

8.6.1 or higher

1.32.0

Enhancement View pull request
Add documentation for how to install alerts

8.6.1 or higher

1.31.2

Enhancement View pull request
Add system testing for state service datastream

8.6.1 or higher

1.31.1

Enhancement View pull request
Update controller manager, proxy and scheduler metrics and dashboards

8.6.1 or higher

1.31.0

Enhancement View pull request
Use datas_tream.dataset as pre filters for dashboards and remove tags

8.6.0 or higher

1.30.0

Enhancement View pull request
Add missing namespace_uid and namespace_labels fields

8.6.0 or higher

1.29.2

Bug fix View pull request
Fix function for memory node usage

8.5.0 or higher

1.29.1

Bug fix View pull request
Fix removed condition setting for container_logs

8.5.0 or higher

1.29.0

Bug fix View pull request
Remove "Control Plane" column from Node Information table

8.5.0 or higher

1.28.2

Bug fix View pull request
Fix Pod Memory usage panel title

8.5.0 or higher

1.28.1

Enhancement View pull request
Delete statefulset, job and cronjob visualizations from Cluster Overview dashboard

8.5.0 or higher

1.28.0

Enhancement View pull request
Adding banner for Kube-state metrics

8.5.0 or higher

1.27.1

Enhancement View pull request
Fix typo in cluster overview dashboard

8.5.0 or higher

1.27.0

Enhancement View pull request
New cluster overview dashboard

8.5.0 or higher

1.26.0

Enhancement View pull request
Add processors configuration option for Kubernetes data_streams

8.4.0 or higher

1.25.0

Enhancement View pull request
Add condition configuration option to container logs data stream

8.4.0 or higher

1.24.0

Enhancement View pull request
Add fields to audit logs data stream

8.4.0 or higher

1.23.1

Enhancement View pull request
Add missing dimension fields

8.4.0 or higher

1.23.0

Enhancement View pull request
Add fields to audit logs data stream

8.4.0 or higher

1.22.1

Enhancement View pull request
Fix overlapping fields in state_job data stream

8.4.0 or higher

1.22.0

Enhancement View pull request
Update apiserver and controllermanaged deprecated fields and dashboards

8.4.0 or higher

1.21.2

Bug fix View pull request
add container ID and pod name as part of Kubernetes Cotainer Logs filestream input

8.3.0 or higher

1.21.1

Enhancement View pull request
improved the wording of the link to Kubernetes documentation

8.3.0 or higher

1.21.0

Enhancement View pull request
Add new dashboards

8.3.0 or higher

1.20.0

Enhancement View pull request
Change fields type for audit_logs data_stream to use requestObject and responseObject fields of audit events. Disable dynamic mapping for audit_logs data_stream. Drop kubernetes.audit.responseObject.metadata and kubernetes.audit.requestObject.metadata

8.2.0 or higher

1.19.1

Enhancement View pull request
Add documentation for volume field

8.2.0 or higher

1.19.0

Enhancement View pull request
Add missed ecs fields

8.2.0 or higher

1.18.1

Enhancement View pull request
Add documentation for multi-fields

8.2.0 or higher

1.18.0

Enhancement View pull request
Fix k8s overview dashboard

8.2.0 or higher

1.17.3

Bug fix View pull request
Remove incorrectly tagged boolean dimension

7.16.0 or higher
8.0.0 or higher

1.17.2

Bug fix View pull request
Add missing metadata fields

7.16.0 or higher
8.0.0 or higher

1.17.1

Enhancement View pull request
Improve default ndjson parser configuration

—

1.17.0

Enhancement View pull request
Disable audit logs collection by default

—

1.16.0

Enhancement View pull request
Documentation improvements

—

1.15.0

Enhancement View pull request
Add ssl.certificate_authorities configuration

—

1.14.3

Bug fix View pull request
Add missing job.name and cronjob.name fields to state_container datastream

—

1.14.2

Bug fix View pull request
Add missing job.name and cronjob.name fields to container related datastreams

—

1.14.1

Bug fix View pull request
Add missing job.name and cronjob.name fields added by metadata generators

—

1.14.0

Enhancement View pull request
Tune state_metrics settings

—

1.13.0

Enhancement View pull request
Update to ECS 8.0

—

1.12.0

Enhancement View pull request
Expose add_recourse_metadata configuration option

—

1.11.0

Enhancement View pull request
Add memory.working_set.limit.pct for pod and container data streams

—

1.10.0

Enhancement View pull request
Add leader election in state_job data stream

—

1.9.0

Enhancement View pull request
Add missing fields

7.16.0 or higher
8.0.0 or higher

1.8.1

Bug fix View pull request
Set kubernetes.volume.fs.used.pct to scaled_float

7.16.0 or higher
8.0.0 or higher

1.8.0

Enhancement View pull request
Support json logs parsing

7.16.0 or higher
8.0.0 or higher

1.7.0

Enhancement View pull request
Add new audit logs data stream in kubernetes integration

7.16.0 or higher
8.0.0 or higher

1.6.0

Enhancement View pull request
Add skip_older option for event datastream

7.16.0 or higher
8.0.0 or higher

1.5.0

Enhancement View pull request
Revert Kubernetes namespace field breaking change

7.16.0 or higher
8.0.0 or higher

1.4.2

Enhancement View pull request
Add dimension fields

—

1.4.1

Enhancement View pull request
Remove overriding of index pattern on the Kubernetes overview dashboard

8.0.0 or higher

1.4.0

Enhancement View pull request
Use filestream input for container_logs data stream

—

1.3.3

Bug fix View pull request
Fix conditions of data_streams that are based on k8s labels & add condition in pipelines

—

1.3.2

Enhancement View pull request
Set default host for proxy to localhost

—

1.3.1

Enhancement View pull request
Uniform with guidelines

—

1.3.0

Enhancement View pull request
Add container_logs ecs fields

—

1.2.1

Bug fix View pull request
Update Kubernetes cluster_ip field type

—

1.2.0

Enhancement View pull request
Update Kubernetes namespace field

—

1.1.1

Bug fix View pull request
Update Kubernetes integration Readme

—

1.1.0

Enhancement View pull request
Update to ECS 1.12.0

7.15.0 or higher

1.0.0

Enhancement View pull request
Release Kubernetes as GA

—

0.14.1

Enhancement View pull request
Update default host in kubernetes proxy data stream in kubernetes integration

—

0.14.0

Enhancement View pull request
Add new container logs data stream in kubernetes integration

—

0.13.0

Enhancement View pull request
Leverage dynamic kubernetes provider for controller and scheduler datastream

—

0.12.2

Bug fix View pull request
Add missing field "kubernetes.daemonset.name" field for pod and container data streams

—

0.12.1

Bug fix View pull request
Add missing cluster filter for "orchestrator.cluster.name" field in [Metrics Kubernetes] Overview dashboard and Dashboard section in the integration overview page

—

0.12.0

Enhancement View pull request
Update kubernetes package ecs fields with orchestrator.cluster.url and orchestrator.cluster.name

—

0.11.1

Enhancement View pull request
Escape special characters in docs

—

0.11.0

Enhancement View pull request
Update documentation to fit mdx spec

—

0.10.0

Enhancement View pull request
Update integration description

—

0.9.1

Bug fix View pull request
Add missing field "kubernetes.daemonset.name" field for state_pod and state_container

—

0.9.0

Enhancement View pull request
Enhance kubernetes package with state_job data stream

—

0.8.0

Enhancement View pull request
Leverage leader election in kubernetes integration

—

0.7.0

Enhancement View pull request
Add _meta information to Kubernetes fields

—

0.6.0

Enhancement View pull request
Introduce kubernetes package granularity using input_groups

—

0.5.3

Enhancement View pull request
Add missing field "kubernetes.statefulset.replicas.ready"

—

0.5.2

Bug fix View pull request
Fix stack compatability

—

0.5.1

Bug fix View pull request
Fix references to env variables

—

0.5.0

Enhancement View pull request
Add missing field "kubernetes.selectors.*" and extra https settings for controllermanager and scheduler datastreams

—

0.4.5

Enhancement View pull request
Add missing field "kubernetes.pod.ip"

—

0.4.4

Enhancement View pull request
Updating package owner

—

0.4.3

Bug fix View pull request
Correct sample event file.

—

0.4.2

Bug fix View pull request
Change kibana.version constraint to be more conservative.

—

0.4.1

Enhancement View pull request
Add missing fields

—

0.1.0

Enhancement View pull request
initial release

—

On this page