Monitor Type: kubernetes-scheduler (Source)
Accepts Endpoints: Yes
Multiple Instances Allowed: Yes
Exports Prometheus metrics from the kube-scheduler.
To activate this monitor in the Smart Agent, add the following to your agent config:
monitors: # All monitor config goes under this key
- type: kubernetes-scheduler
... # Additional config
For a list of monitor options that are common to all monitors, see Common Configuration.
| Config 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) |
These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.
apiserver_audit_event_total(cumulative)
Counter of audit events generated and sent to the audit backend.apiserver_audit_requests_rejected_total(cumulative)
Counter of apiserver requests rejected due to an error in audit logging backend.apiserver_client_certificate_expiration_seconds(cumulative)
Distribution of the remaining lifetime on the certificate used to authenticate a request. (sum)apiserver_client_certificate_expiration_seconds_bucket(cumulative)
Distribution of the remaining lifetime on the certificate used to authenticate a request. (bucket)apiserver_client_certificate_expiration_seconds_count(cumulative)
Distribution of the remaining lifetime on the certificate used to authenticate a request. (count)apiserver_storage_data_key_generation_duration_seconds(cumulative)
Latencies in seconds of data encryption key(DEK) generation operations. (sum)apiserver_storage_data_key_generation_duration_seconds_bucket(cumulative)
Latencies in seconds of data encryption key(DEK) generation operations. (bucket)apiserver_storage_data_key_generation_duration_seconds_count(cumulative)
Latencies in seconds of data encryption key(DEK) generation operations. (count)apiserver_storage_data_key_generation_failures_total(cumulative)
Total number of failed data encryption key(DEK) generation operations.apiserver_storage_data_key_generation_latencies_microseconds(cumulative)
(Deprecated) Latencies in microseconds of data encryption key(DEK) generation operations. (sum)apiserver_storage_data_key_generation_latencies_microseconds_bucket(cumulative)
(Deprecated) Latencies in microseconds of data encryption key(DEK) generation operations. (bucket)apiserver_storage_data_key_generation_latencies_microseconds_count(cumulative)
(Deprecated) Latencies in microseconds of data encryption key(DEK) generation operations. (count)apiserver_storage_envelope_transformation_cache_misses_total(cumulative)
Total number of cache misses while accessing key decryption key(KEK).go_gc_duration_seconds(cumulative)
A summary of the GC invocation durations. (sum)go_gc_duration_seconds_count(cumulative)
A summary of the GC invocation durations. (count)go_gc_duration_seconds_quantile(gauge)
A summary of the GC invocation durations. (quantized)go_goroutines(gauge)
Number of goroutines that currently exist.go_info(gauge)
Information about the Go environment.go_memstats_alloc_bytes(gauge)
Number of bytes allocated and still in use.go_memstats_alloc_bytes_total(cumulative)
Total number of bytes allocated, even if freed.go_memstats_buck_hash_sys_bytes(gauge)
Number of bytes used by the profiling bucket hash table.go_memstats_frees_total(cumulative)
Total number of frees.go_memstats_gc_cpu_fraction(gauge)
The fraction of this program's available CPU time used by the GC since the program started.go_memstats_gc_sys_bytes(gauge)
Number of bytes used for garbage collection system metadata.go_memstats_heap_alloc_bytes(gauge)
Number of heap bytes allocated and still in use.go_memstats_heap_idle_bytes(gauge)
Number of heap bytes waiting to be used.go_memstats_heap_inuse_bytes(gauge)
Number of heap bytes that are in use.go_memstats_heap_objects(gauge)
Number of allocated objects.go_memstats_heap_released_bytes(gauge)
Number of heap bytes released to OS.go_memstats_heap_sys_bytes(gauge)
Number of heap bytes obtained from system.go_memstats_last_gc_time_seconds(gauge)
Number of seconds since 1970 of last garbage collection.go_memstats_lookups_total(cumulative)
Total number of pointer lookups.go_memstats_mallocs_total(cumulative)
Total number of mallocs.go_memstats_mcache_inuse_bytes(gauge)
Number of bytes in use by mcache structures.go_memstats_mcache_sys_bytes(gauge)
Number of bytes used for mcache structures obtained from system.go_memstats_mspan_inuse_bytes(gauge)
Number of bytes in use by mspan structures.go_memstats_mspan_sys_bytes(gauge)
Number of bytes used for mspan structures obtained from system.go_memstats_next_gc_bytes(gauge)
Number of heap bytes when next garbage collection will take place.go_memstats_other_sys_bytes(gauge)
Number of bytes used for other system allocations.go_memstats_stack_inuse_bytes(gauge)
Number of bytes in use by the stack allocator.go_memstats_stack_sys_bytes(gauge)
Number of bytes obtained from system for stack allocator.go_memstats_sys_bytes(gauge)
Number of bytes obtained from system.go_threads(gauge)
Number of OS threads created.http_request_duration_microseconds(cumulative)
The HTTP request latencies in microseconds. (sum)http_request_duration_microseconds_count(cumulative)
The HTTP request latencies in microseconds. (count)http_request_duration_microseconds_quantile(gauge)
The HTTP request latencies in microseconds. (quantized)http_request_size_bytes(cumulative)
The HTTP request sizes in bytes. (sum)http_request_size_bytes_count(cumulative)
The HTTP request sizes in bytes. (count)http_request_size_bytes_quantile(gauge)
The HTTP request sizes in bytes. (quantized)http_requests_total(cumulative)
Total number of HTTP requests made.http_response_size_bytes(cumulative)
The HTTP response sizes in bytes. (sum)http_response_size_bytes_count(cumulative)
The HTTP response sizes in bytes. (count)http_response_size_bytes_quantile(gauge)
The HTTP response sizes in bytes. (quantized)kubernetes_build_info(gauge)
A metric with a constant '1' value labeled by major, minor, git version, git commit, git tree state, build date, Go version, and compiler from which Kubernetes was built, and platform on which it is running.leader_election_master_status(gauge)
Gauge of if the reporting system is master of the relevant lease, 0 indicates backup, 1 indicates master. 'name' is the string used to identify the lease. Please make sure to group by name.process_cpu_seconds_total(cumulative)
Total user and system CPU time spent in seconds.process_max_fds(gauge)
Maximum number of open file descriptors.process_open_fds(gauge)
Number of open file descriptors.process_resident_memory_bytes(gauge)
Resident memory size in bytes.process_start_time_seconds(gauge)
Start time of the process since unix epoch in seconds.process_virtual_memory_bytes(gauge)
Virtual memory size in bytes.process_virtual_memory_max_bytes(gauge)
Maximum amount of virtual memory available in bytes.rest_client_request_duration_seconds(cumulative)
Request latency in seconds. Broken down by verb and URL. (sum)rest_client_request_duration_seconds_bucket(cumulative)
Request latency in seconds. Broken down by verb and URL. (bucket)rest_client_request_duration_seconds_count(cumulative)
Request latency in seconds. Broken down by verb and URL. (count)rest_client_request_latency_seconds(cumulative)
(Deprecated) Request latency in seconds. Broken down by verb and URL. (sum)rest_client_request_latency_seconds_bucket(cumulative)
(Deprecated) Request latency in seconds. Broken down by verb and URL. (bucket)rest_client_request_latency_seconds_count(cumulative)
(Deprecated) Request latency in seconds. Broken down by verb and URL. (count)rest_client_requests_total(cumulative)
Number of HTTP requests, partitioned by status code, method, and host.scheduler_binding_duration_seconds(cumulative)
Binding latency in seconds (sum)scheduler_binding_duration_seconds_bucket(cumulative)
Binding latency in seconds (bucket)scheduler_binding_duration_seconds_count(cumulative)
Binding latency in seconds (count)scheduler_binding_latency_microseconds(cumulative)
(Deprecated) Binding latency in microseconds (sum)scheduler_binding_latency_microseconds_bucket(cumulative)
(Deprecated) Binding latency in microseconds (bucket)scheduler_binding_latency_microseconds_count(cumulative)
(Deprecated) Binding latency in microseconds (count)scheduler_e2e_scheduling_duration_seconds(cumulative)
E2e scheduling latency in seconds (scheduling algorithm + binding) (sum)scheduler_e2e_scheduling_duration_seconds_bucket(cumulative)
E2e scheduling latency in seconds (scheduling algorithm + binding) (bucket)scheduler_e2e_scheduling_duration_seconds_count(cumulative)
E2e scheduling latency in seconds (scheduling algorithm + binding) (count)scheduler_e2e_scheduling_latency_microseconds(cumulative)
(Deprecated) E2e scheduling latency in microseconds (scheduling algorithm + binding) (sum)scheduler_e2e_scheduling_latency_microseconds_bucket(cumulative)
(Deprecated) E2e scheduling latency in microseconds (scheduling algorithm + binding) (bucket)scheduler_e2e_scheduling_latency_microseconds_count(cumulative)
(Deprecated) E2e scheduling latency in microseconds (scheduling algorithm + binding) (count)scheduler_pending_pods(gauge)
Number of pending pods, by the queue type. 'active' means number of pods in activeQ; 'backoff' means number of pods in backoffQ; 'unschedulable' means number of pods in unschedulableQ.scheduler_pod_preemption_victims(gauge)
Number of selected preemption victimsscheduler_schedule_attempts_total(cumulative)
Number of attempts to schedule pods, by the result. 'unschedulable' means a pod could not be scheduled, while 'error' means an internal scheduler problem.scheduler_scheduling_algorithm_duration_seconds(cumulative)
Scheduling algorithm latency in seconds (sum)scheduler_scheduling_algorithm_duration_seconds_bucket(cumulative)
Scheduling algorithm latency in seconds (bucket)scheduler_scheduling_algorithm_duration_seconds_count(cumulative)
Scheduling algorithm latency in seconds (count)scheduler_scheduling_algorithm_latency_microseconds(cumulative)
(Deprecated) Scheduling algorithm latency in microseconds (sum)scheduler_scheduling_algorithm_latency_microseconds_bucket(cumulative)
(Deprecated) Scheduling algorithm latency in microseconds (bucket)scheduler_scheduling_algorithm_latency_microseconds_count(cumulative)
(Deprecated) Scheduling algorithm latency in microseconds (count)scheduler_scheduling_algorithm_predicate_evaluation(cumulative)
(Deprecated) Scheduling algorithm predicate evaluation duration in microseconds (sum)scheduler_scheduling_algorithm_predicate_evaluation_bucket(cumulative)
(Deprecated) Scheduling algorithm predicate evaluation duration in microseconds (bucket)scheduler_scheduling_algorithm_predicate_evaluation_count(cumulative)
(Deprecated) Scheduling algorithm predicate evaluation duration in microseconds (count)scheduler_scheduling_algorithm_predicate_evaluation_seconds(cumulative)
Scheduling algorithm predicate evaluation duration in seconds (sum)scheduler_scheduling_algorithm_predicate_evaluation_seconds_bucket(cumulative)
Scheduling algorithm predicate evaluation duration in seconds (bucket)scheduler_scheduling_algorithm_predicate_evaluation_seconds_count(cumulative)
Scheduling algorithm predicate evaluation duration in seconds (count)scheduler_scheduling_algorithm_preemption_evaluation(cumulative)
(Deprecated) Scheduling algorithm preemption evaluation duration in microseconds (sum)scheduler_scheduling_algorithm_preemption_evaluation_bucket(cumulative)
(Deprecated) Scheduling algorithm preemption evaluation duration in microseconds (bucket)scheduler_scheduling_algorithm_preemption_evaluation_count(cumulative)
(Deprecated) Scheduling algorithm preemption evaluation duration in microseconds (count)scheduler_scheduling_algorithm_preemption_evaluation_seconds(cumulative)
Scheduling algorithm preemption evaluation duration in seconds (sum)scheduler_scheduling_algorithm_preemption_evaluation_seconds_bucket(cumulative)
Scheduling algorithm preemption evaluation duration in seconds (bucket)scheduler_scheduling_algorithm_preemption_evaluation_seconds_count(cumulative)
Scheduling algorithm preemption evaluation duration in seconds (count)scheduler_scheduling_algorithm_priority_evaluation(cumulative)
(Deprecated) Scheduling algorithm priority evaluation duration in microseconds (sum)scheduler_scheduling_algorithm_priority_evaluation_bucket(cumulative)
(Deprecated) Scheduling algorithm priority evaluation duration in microseconds (bucket)scheduler_scheduling_algorithm_priority_evaluation_count(cumulative)
(Deprecated) Scheduling algorithm priority evaluation duration in microseconds (count)scheduler_scheduling_algorithm_priority_evaluation_seconds(cumulative)
Scheduling algorithm priority evaluation duration in seconds (sum)scheduler_scheduling_algorithm_priority_evaluation_seconds_bucket(cumulative)
Scheduling algorithm priority evaluation duration in seconds (bucket)scheduler_scheduling_algorithm_priority_evaluation_seconds_count(cumulative)
Scheduling algorithm priority evaluation duration in seconds (count)scheduler_scheduling_duration_seconds(cumulative)
Scheduling latency in seconds split by sub-parts of the scheduling operation (sum)scheduler_scheduling_duration_seconds_count(cumulative)
Scheduling latency in seconds split by sub-parts of the scheduling operation (count)scheduler_scheduling_duration_seconds_quantile(gauge)
Scheduling latency in seconds split by sub-parts of the scheduling operation (quantized)scheduler_scheduling_latency_seconds(cumulative)
(Deprecated) Scheduling latency in seconds split by sub-parts of the scheduling operation (sum)scheduler_scheduling_latency_seconds_count(cumulative)
(Deprecated) Scheduling latency in seconds split by sub-parts of the scheduling operation (count)scheduler_scheduling_latency_seconds_quantile(gauge)
(Deprecated) Scheduling latency in seconds split by sub-parts of the scheduling operation (quantized)scheduler_total_preemption_attempts(cumulative)
Total preemption attempts in the cluster till nowscheduler_volume_scheduling_duration_seconds(cumulative)
Volume scheduling stage latency (sum)scheduler_volume_scheduling_duration_seconds_bucket(cumulative)
Volume scheduling stage latency (bucket)scheduler_volume_scheduling_duration_seconds_count(cumulative)
Volume scheduling stage latency (count)
To emit metrics that are not default, you can add those metrics in the
generic monitor-level extraMetrics config option. Metrics that are derived
from specific configuration options that do not appear in the above list of
metrics do not need to be added to extraMetrics.
To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.