Container monitoring metric definition file (metrics_kubernetes.conf)

Syntax

[
  {
    "name":"metric-name-of-trend-data",
    "default":default-selection-status,
    "promql":"PromQL-statement",
    "resource_en":{
      "category":"metric-category-in-English",
      "label":"metric-label-in-English",
      "description":"metric-description-in-English",
      "unit":"metric-unit-in-English"
    },
    "resource_ja":{
      "category":"metric-category-in-Japanese",
      "label":"metric-label-in-Japanese",
      "description":"metric-description-in-Japanese",
      "unit":"metric-unit-in-Japanese"
    },
    "module": "component-name"
  }, ...
]#

#

The number of elements that can be written inside the brackets ([]) is from 1 to 1,000. A KAJY24609-E error message is output when writing a number of elements that falls outside this range.

To Page Top

File

metrics_kubernetes.conf

metrics_kubernetes.conf.model (model file)

To Page Top

Storage directory

For Windows

When using a physical host

Manager-path\conf\imdd\plugin\jp1pccs_kubernetes\

When using a logical host

shared-folder\jp1imm\conf\imdd\plugin\jp1pccs_kubernetes\

For Linux

When using a physical host

/etc/opt/jp1imm/conf/imdd/plugin/jp1pccs_kubernetes/

When using a logical host

shared-directory/jp1imm/conf/imdd/plugin/jp1pccs_kubernetes/

To Page Top

Description

This file defines the metric information of the container monitoring displayed on the Trends tab, Dashboard tab, and Dashboard List dialog box of the Integrated Operation Viewer window.

Definitions are used for the return values of the __metricListGet method and __timeSeriesDataGet method for JP1/IM - Agent product plug-ins. If JP1/IM - Manager is in a hierarchical configuration and trend data stored in the database of a lower-level manager is referenced from an upper-level manager, you must add the metrics of the referenced trend data to the metrics definition file of the upper-level manager.

To Page Top

Character encoding

UTF-8 (without BOM)

To Page Top

Linefeed code

In Windows: CR+LF

In Linux: LF

To Page Top

Timing in which definitions are reflected

Definitions are reflected when the metric information is obtained on the Trends tab, Dashboard tab, and Dashboard List dialog box of the Integrated Operation Viewer window, or with the REST API.

To Page Top

Content description

For details, see Content description in Node exporter metric definition file (metrics_node_exporter.conf) (2. Definition Files) for JP1/IM - Agent. However, the module member is required and the component type is specified. The value specified here is used as the object root type.

To Page Top

Model file settings (initial status)

The settings (initial status) of each metric described in the model file of the container monitoring metric definition file are shown below.

• kube_job_status_failed

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_job_status_failed
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		kube_job_status_failed * on(job_name, namespace) group_left() kube_job_owner{owner_kind=\"<none>\", owner_name=\"<none>\"} and $jp1im_TrendData_labels
  resource_en	category	kubernete_job
  	label	Number of Failed pods
  	description	The number of pods which reached Phase Failed and the reason for failure. This number does not include pods run from a CronJob.
  	unit	count
  module		kubernetes/Namespace

• kube_pod_status_pending

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_status_pending
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_pod_status_phase{phase=\"Pending\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Number of Pending pods
  	description	The number of pods whose Phase is Pending.
  	unit	count
  module		kubernetes/Namespace

• kube_pod_status_failed

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_status_failed
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_pod_status_phase{phase=\"Failed\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Number of Failed pods
  	description	The number of pods whose Phase is Failed.
  	unit	count
  module		kubernetes/Namespace

• kube_pod_status_unknown

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_status_unknown
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_pod_status_phase{phase=\"Unknown\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Number of Unknown pods
  	description	The number of pods whose Phase is Unknown.
  	unit	count
  module		kubernetes/Namespace

• kube_daemonset_failed_number_scheduled

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_daemonset_failed_number_scheduled
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		(kube_daemonset_status_desired_number_scheduled - kube_daemonset_status_current_number_scheduled) and $jp1im_TrendData_labels
  resource_en	category	kubernetes_daemon_set
  	label	Number of nodes failed to run
  	description	The difference between the number of nodes that need to run daemon pods (desired) and the number of nodes that are already running (current).
  	unit	count
  module		kubernetes/DaemonSet

• kube_deployment_failed_replicas

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_deployment_failed_replicas
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		(kube_deployment_spec_replicas - kube_deployment_status_replicas_available) and $jp1im_TrendData_labels
  resource_en	category	kubernetes_deploymen
  	label	Number of pods failed to run
  	description	The difference between the number of required pods and the number of available replicas.
  	unit	count
  module		kubernetes/Deployment

• kube_replicaset_failed_replicas

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_replicaset_failed_replicas
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		(kube_replicaset_spec_replicas - kube_replicaset_status_ready_replicas) and $jp1im_TrendData_labels
  resource_en	category	kubernetes_replica_set
  	label	Number of pods failed to run
  	description	The difference between the number of required pods and the number of ready replicas.
  	unit	count
  module		kubernetes/ReplicaSet

• kube_statefulset_failed_replicas

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_statefulset_failed_replicas
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		(kube_statefulset_replicas - kube_statefulset_status_replicas_ready) and $jp1im_TrendData_labels
  resource_en	category	kubernetes_stateful_set
  	label	Number of pods failed to run
  	description	The difference between the number of required pods and the number of ready replicas.
  	unit	count
  module		kubernetes/StaetfulSet

• kube_cron_job_status_failed

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_cron_job_status_failed
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		kube_job_status_failed * on(job_name, namespace) group_left(jp1_pc_nodelabel) kube_job_owner{owner_kind=\"CronJob\", owner_name!=\"<none>\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_cron_job
  	label	Number of pods failed to run
  	description	The number of pods that failed to run within a CronJob.
  	unit	count
  module		kubernetes/CronJob

• kube_node_status_condition_not_ready

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_node_status_condition_not_ready
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (node, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_node_status_condition{condition=\"Ready\",status=~\"false|unknown\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_node
  	label	Status
  	description	Whether the node is in an error state. (1: Not Ready or Unknown, 0: Ready)
  	unit	count
  module		kubernetes/Node

• kube_node_status_condition_memory_pressure

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_node_status_condition_memory_pressure
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (node, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_node_status_condition{condition=\"MemoryPressure\",status=~\"true|unknown\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_node
  	label	Memory pressure
  	description	Whether memory is under pressure. (1: Under Pressure or Unknown, 0: Normal)
  	unit	count
  module		kubernetes/Node

• kube_node_status_condition_disk_pressure

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_node_status_condition_disk_pressure
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (node, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_node_status_condition{condition=\"DiskPressure\",status=~\"true|unknown\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_node
  	label	Disk pressure
  	description	Whether disk is under pressure. (1: Under Pressure or Unknown, 0: Normal)
  	unit	count
  module		kubernetes/Node

• kube_node_status_condition_pid_pressure

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_node_status_condition_pid_pressure
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (node, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (kube_node_status_condition{condition=\"PIDPressure\",status=~\"true|unknown\"} and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_node
  	label	PID pressure
  	description	Whether PID is under pressure. (1: Under Pressure or Unknown, 0: Normal)
  	unit	count
  module		kubernetes/Node

• kube_pod_cpu_percent_used

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_cpu_percent_used
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_cpu_usage_seconds_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	CPU usage
  	description	CPU usage per pod.
  	unit	%
  module		kubernetes/Namespace

• kube_pod_fs_reads_bps

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_fs_reads_bps
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_reads_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk read bytes
  	description	Disk read bytes per pod.
  	unit	Bps
  module		kubernetes/Namespace

• kube_pod_fs_writes_bps

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_fs_writes_bps
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_writes_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk write bytes
  	description	Disk write bytes per pod.
  	unit	Bps
  module		kubernetes/Namespace

• kube_pod_memory_percent_used

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_memory_percent_used
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (container_memory_working_set_bytes and (container_spec_memory_limit_bytes > 0) and $jp1im_TrendData_labels) / sum by (pod, namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) ((container_spec_memory_limit_bytes > 0) and container_memory_working_set_bytes and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	Memory usage
  	description	Memory usage per pod.
  	unit	%
  module		kubernetes/Namespace

• kube_namespace_cpu_percent_used

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_namespace_cpu_percent_used
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_cpu_usage_seconds_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	CPU usage
  	description	CPU usage per namespace.
  	unit	%
  module		kubernetes/Cluster

• kube_namespace_fs_reads_bps

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_namespace_fs_reads_bps
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_reads_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk read bytes
  	description	Disk read bytes per namespace.
  	unit	Bps
  module		kubernetes/Cluster

• kube_namespace_fs_writes_bps

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_namespace_fs_writes_bps
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_writes_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk write bytes
  	description	Disk write bytes per namespace.
  	unit	Bps
  module		kubernetes/Cluster

• kube_namespace_memory_percent_used

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_namespace_memory_percent_used
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (container_memory_working_set_bytes and (container_spec_memory_limit_bytes > 0) and $jp1im_TrendData_labels) / sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) ((container_spec_memory_limit_bytes > 0) and container_memory_working_set_bytes and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	Memory usage
  	description	Memory usage per namespace.
  	unit	%
  module		kubernetes/Cluster

• kube_pod_status_phase

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_status_phase
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		kube_pod_status_phase and $jp1im_TrendData_labels
  resource_en	category	kubernetes_pod
  	label	Phase
  	description	The pods current phase
  	unit	-
  module		kubernetes/Pod

• kube_pod_cpu_percent_used_pod

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_cpu_percent_used_pod
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_cpu_usage_seconds_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	CPU usage
  	description	CPU usage per pod.
  	unit	%
  module		kubernetes/Pod

• kube_pod_fs_reads_bps_pod

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_fs_reads_bps_pod
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_reads_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk read bytes
  	description	Disk read bytes per pod.
  	unit	Bps
  module		kubernetes/Pod

• kube_pod_fs_writes_bps_pod

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_fs_writes_bps_pod
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (rate(container_fs_writes_bytes_total[$stepTime{minSeconds=\"120\"}]) and $jp1im_TrendData_labels)
  resource_en	category	kubernetes_pod
  	label	Disk write bytes
  	description	Disk write bytes per pod.
  	unit	Bps
  module		kubernetes/Pod

• kube_pod_memory_percent_used_pod

  ■Settings (initial status)

  Member name		Settings (initial status)
  name		kube_pod_memory_percent_used_pod
  default		true
  promql for the metric definition file (including $jp1im_TrendData_labels)		sum by (namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) (container_memory_working_set_bytes and (container_spec_memory_limit_bytes > 0) and $jp1im_TrendData_labels) / sum by ( namespace, instance, job, jp1_pc_nodelabel, jp1_pc_prome_hostname) ((container_spec_memory_limit_bytes > 0) and container_memory_working_set_bytes and $jp1im_TrendData_labels) * 100
  resource_en	category	kubernetes_pod
  	label	Memory usage
  	description	Memory usage per pod.
  	unit	%
  module		kubernetes/Pod

To Page Top