Skip to content

SCHEMA.md

Latest commit

 

History

History
844 lines (596 loc) · 42.3 KB

SCHEMA.md

File metadata and controls

844 lines (596 loc) · 42.3 KB

Metric Record

Title: Metric Record
Type object
Required No
Additional properties Not allowed

Description: JSON schema for metric logs emitted by the kube-transition-metrics controller

Property Type Title/Description
+ kube_transition_metrics Combination Metrics
+ time string Metric Timestamp
- message string Message

1. Property Metric Record > kube_transition_metrics

Title: Metrics
Type combining
Required Yes
Additional properties Not allowed

Description: The metrics pertaining to pod_name

Property Type Title/Description
- type enum (of string) Metric type
- partial boolean Partial metric
- kube_namespace string Kubernetes Namespace name
- pod_name string Kubernetes Pod name
- kube_node string Kubernetes Node name
- kube_qos enum (of string) Kubernetes QOS class
- kube_priority_class string Kubernetes Priority class
- kube_runtime_class string Kubernetes Runtime class
- kube_ownerref_kind string Kubernetes Owner Reference Kind
- kube_ownerref_name string Kubernetes Owner Reference Name
- kube_cronjob string Kubernetes CronJob
- kube_daemon_set string Kubernetes DaemonSet
- kube_deployment string Kubernetes Deployment
- kube_job string Kubernetes Job
- kube_replica_set string Kubernetes ReplicaSet
- kube_statefulset string Kubernetes StatefulSet
- kube_service string Kubernetes Service
- kube_app_component string Kubernetes App Component
- kube_app_instance string Kubernetes App Instance
- kube_app_managed_by string Kubernetes App Managed By
- kube_app_name string Kubernetes App Name
- kube_app_part_of string Kubernetes App Part Of
- kube_app_version string Kubernetes App Version
- container_name string Container name
- short_image string Short Image
- image_name string Image name
- image_tag string Image tag
- pod object Pod Metrics
- container object Container Metrics
- image_pull object Image Pull Metrics
All of(Requirement)
item 0
item 1

1.1. Property Metric Record > kube_transition_metrics > allOf > item 0
Type object
Required No
Additional properties Any type allowed

1.1.1. The following properties are required

  • kube_namespace
  • pod_name
  • type
  • partial

1.2. Property Metric Record > kube_transition_metrics > allOf > item 1
Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
item 2

1.2.1. Property Metric Record > kube_transition_metrics > allOf > item 1 > oneOf > item 0
Type object
Required No
Additional properties Any type allowed
1.2.1.1. The following properties are required
  • pod

1.2.2. Property Metric Record > kube_transition_metrics > allOf > item 1 > oneOf > item 1
Type object
Required No
Additional properties Any type allowed
1.2.2.1. The following properties are required
  • container

1.2.3. Property Metric Record > kube_transition_metrics > allOf > item 1 > oneOf > item 2
Type object
Required No
Additional properties Any type allowed
1.2.3.1. The following properties are required
  • image_pull

1.3. Property Metric Record > kube_transition_metrics > type

Title: Metric type
Type enum (of string)
Required No

Description: The type of metric included in kube_transition_metrics

Must be one of:

  • "pod"
  • "container"
  • "image_pull"

1.4. Property Metric Record > kube_transition_metrics > partial

Title: Partial metric
Type boolean
Required No

Description: True if this metric is a partial metric, otherwise false. Partial metrics are emitted before the kube-transition-metrics controller is able to obtain the final metric, for example if the pod has not yet become ready.

1.5. Property Metric Record > kube_transition_metrics > kube_namespace

Title: Kubernetes Namespace name
Type string
Required No

Description: The name of the Kubernetes Namespace containing the pod

1.6. Property Metric Record > kube_transition_metrics > pod_name

Title: Kubernetes Pod name
Type string
Required No

Description: The name of the Kubernetes Pod to which metrics pertain

1.7. Property Metric Record > kube_transition_metrics > kube_node

Title: Kubernetes Node name
Type string
Required No

Description: The name of the Kubernetes Node running the Pod.

1.8. Property Metric Record > kube_transition_metrics > kube_qos

Title: Kubernetes QOS class
Type enum (of string)
Required No

Description: The Kubernetes QOS class of the pod

Must be one of:

  • "Guaranteed"
  • "Burstable"
  • "BestEffort"

1.9. Property Metric Record > kube_transition_metrics > kube_priority_class

Title: Kubernetes Priority class
Type string
Required No

Description: The Kubernetes Priority class of the Pod.

1.10. Property Metric Record > kube_transition_metrics > kube_runtime_class

Title: Kubernetes Runtime class
Type string
Required No

Description: The Kubernetes Runtime class of the Pod.

1.11. Property Metric Record > kube_transition_metrics > kube_ownerref_kind

Title: Kubernetes Owner Reference Kind
Type string
Required No

Description: The Kubernetes controller Kind of the Pod.

1.12. Property Metric Record > kube_transition_metrics > kube_ownerref_name

Title: Kubernetes Owner Reference Name
Type string
Required No

Description: The Kubernetes controller Name of the Pod.

1.13. Property Metric Record > kube_transition_metrics > kube_cronjob

Title: Kubernetes CronJob
Type string
Required No

Description: The Kubernetes CronJob of the pod (currently unsupported).

1.14. Property Metric Record > kube_transition_metrics > kube_daemon_set

Title: Kubernetes DaemonSet
Type string
Required No

Description: The Kubernetes DaemonSet of the pod.

1.15. Property Metric Record > kube_transition_metrics > kube_deployment

Title: Kubernetes Deployment
Type string
Required No

Description: The Kubernetes Deployment of the pod (currently unsupported).

1.16. Property Metric Record > kube_transition_metrics > kube_job

Title: Kubernetes Job
Type string
Required No

Description: The Kubernetes Job of the pod.

1.17. Property Metric Record > kube_transition_metrics > kube_replica_set

Title: Kubernetes ReplicaSet
Type string
Required No

Description: The Kubernetes ReplicaSet of the pod.

1.18. Property Metric Record > kube_transition_metrics > kube_statefulset

Title: Kubernetes StatefulSet
Type string
Required No

Description: The Kubernetes StatefulSet of the pod.

1.19. Property Metric Record > kube_transition_metrics > kube_service

Title: Kubernetes Service
Type string
Required No

Description: The Kubernetes Service pointing to the pod (currently unsupported).

1.20. Property Metric Record > kube_transition_metrics > kube_app_component

Title: Kubernetes App Component
Type string
Required No

Description: The Kubernetes App Component of the pod (app.kubernetes.io/component).

1.21. Property Metric Record > kube_transition_metrics > kube_app_instance

Title: Kubernetes App Instance
Type string
Required No

Description: The Kubernetes App Instance of the pod (app.kubernetes.io/instance).

1.22. Property Metric Record > kube_transition_metrics > kube_app_managed_by

Title: Kubernetes App Managed By
Type string
Required No

Description: The Kubernetes App Managed By of the pod (app.kubernetes.io/managed-by).

1.23. Property Metric Record > kube_transition_metrics > kube_app_name

Title: Kubernetes App Name
Type string
Required No

Description: The Kubernetes App Name of the pod (app.kubernetes.io/name).

1.24. Property Metric Record > kube_transition_metrics > kube_app_part_of

Title: Kubernetes App Part Of
Type string
Required No

Description: The Kubernetes App Part Of of the pod (app.kubernetes.io/part-of).

1.25. Property Metric Record > kube_transition_metrics > kube_app_version

Title: Kubernetes App Version
Type string
Required No

Description: The Kubernetes App Version of the pod (app.kubernetes.io/version).

1.26. Property Metric Record > kube_transition_metrics > container_name

Title: Container name
Type string
Required No

Description: The name of the container to which metrics pertain, only set for container and image_pull metrics types.

1.27. Property Metric Record > kube_transition_metrics > short_image

Title: Short Image
Type string
Required No

Description: The short image name for the container image (the last path component of the repository), only set for container and image_pull metrics types.

1.28. Property Metric Record > kube_transition_metrics > image_name

Title: Image name
Type string
Required No

Description: The name of the repository for the container image (everyting before tag and digest), only set for container and image_pull metrics types.

1.29. Property Metric Record > kube_transition_metrics > image_tag

Title: Image tag
Type string
Required No

Description: The tag or digest of the container image, only set for container and image_pull metrics types.

1.30. Property Metric Record > kube_transition_metrics > pod

Title: Pod Metrics
Type object
Required No
Additional properties Not allowed

Description: Included if kube_transition_metric_type is equal to "pod".

Property Type Title/Description
+ creation_timestamp string Running Timestamp
- scheduled_timestamp string Scheduled Timestamp
- creation_to_scheduled_seconds number Pod Creation to Scheduled
- initialized_timestamp string initialized Timestamp
- creation_to_initialized_seconds number Pod Creation to Initialized
- scheduled_to_initialized_seconds number Pod Scheduled to Initialized
- ready_timestamp string Ready Timestamp
- creation_to_ready_seconds number Pod Creation to Ready
- initialized_to_ready_seconds number Pod Initialized to Ready

1.30.1. Property Metric Record > kube_transition_metrics > pod > creation_timestamp

Title: Running Timestamp
Type string
Required Yes
Format date-time

Description: The timestamp for when the Pod was created.

1.30.2. Property Metric Record > kube_transition_metrics > pod > scheduled_timestamp

Title: Scheduled Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the Pod was scheduled (Pending->Initializing state).

1.30.3. Property Metric Record > kube_transition_metrics > pod > creation_to_scheduled_seconds

Title: Pod Creation to Scheduled
Type number
Required No

Description: The time in seconds it took to schedule the Pod.

1.30.4. Property Metric Record > kube_transition_metrics > pod > initialized_timestamp

Title: initialized Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the Pod first entered Running state (all init containers exited successfuly and images are pulled). In the event of a pod restart this time is not reset.

1.30.5. Property Metric Record > kube_transition_metrics > pod > creation_to_initialized_seconds

Title: Pod Creation to Initialized
Type number
Required No

Description: The time in seconds from the pod creation to when it was initialized.

1.30.6. Property Metric Record > kube_transition_metrics > pod > scheduled_to_initialized_seconds

Title: Pod Scheduled to Initialized
Type number
Required No

Description: The time in seconds from the pod was scheduled to when it was initialized (Initializing->Running state).

1.30.7. Property Metric Record > kube_transition_metrics > pod > ready_timestamp

Title: Ready Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the Pod first became Ready (all containers had readinessProbe success). In the event of a pod restart this time is not reset.

1.30.8. Property Metric Record > kube_transition_metrics > pod > creation_to_ready_seconds

Title: Pod Creation to Ready
Type number
Required No

Description: The time in seconds from the pod creation to becoming Ready.

1.30.9. Property Metric Record > kube_transition_metrics > pod > initialized_to_ready_seconds

Title: Pod Initialized to Ready
Type number
Required No

Description: The time in seconds from the pod was initialized (Running state) to when it first bacame Ready.

1.31. Property Metric Record > kube_transition_metrics > container

Title: Container Metrics
Type object
Required No
Additional properties Not allowed

Description: Included if kube_transition_metric_type is equal to "container".

Property Type Title/Description
+ init_container boolean Init Container
- previous_to_running_seconds number Previous Container Finished to Running
- initialized_to_running_seconds number Pod Initialized to Running
- running_timestamp string Running Timestamp
- started_timestamp string Started Timestamp
- running_to_started_seconds number Running to Started
- ready_timestamp string Started Timestamp
- running_to_ready_seconds number Running to Ready
- started_to_ready_seconds number Running to Ready

1.31.1. Property Metric Record > kube_transition_metrics > container > init_container

Title: Init Container
Type boolean
Required Yes

Description: True if the container is an init container, otherwise false.

1.31.2. Property Metric Record > kube_transition_metrics > container > previous_to_running_seconds

Title: Previous Container Finished to Running
Type number
Required No

Description: The time in seconds from the previous init container becoming Ready (exited 0) to this container running. Only set for init containers, absent for the first init container.

1.31.3. Property Metric Record > kube_transition_metrics > container > initialized_to_running_seconds

Title: Pod Initialized to Running
Type number
Required No

Description: The time in seconds from the Pod becoming initialized (all init containers exited 0) to this container running. Only set for non-init containers.

1.31.4. Property Metric Record > kube_transition_metrics > container > running_timestamp

Title: Running Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the container first entered Running state (first fork(2)/execve(2) in container environment). In the event of a pod restart, this timestamp is NOT updated.

1.31.5. Property Metric Record > kube_transition_metrics > container > started_timestamp

Title: Started Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the container first started state (startupProbe success). In the event of a pod restart, this timestamp is NOT updated. Only set for non-init containers.

1.31.6. Property Metric Record > kube_transition_metrics > container > running_to_started_seconds

Title: Running to Started
Type number
Required No

Description: The time in seconds from the container becoming running to this container started. Only set for non-init containers.

1.31.7. Property Metric Record > kube_transition_metrics > container > ready_timestamp

Title: Started Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the container first ready state (readinessProbe success). In the event of a pod restart, this timestamp is NOT updated.

1.31.8. Property Metric Record > kube_transition_metrics > container > running_to_ready_seconds

Title: Running to Ready
Type number
Required No

Description: The time in seconds from the container becoming running to this container ready. In init containers, this is the time the container exited with a successful status.

1.31.9. Property Metric Record > kube_transition_metrics > container > started_to_ready_seconds

Title: Running to Ready
Type number
Required No

Description: The time in seconds from the container becoming started to this container ready. Only set for non-init containers.

1.32. Property Metric Record > kube_transition_metrics > image_pull

Title: Image Pull Metrics
Type object
Required No
Additional properties Not allowed

Description: Included if kube_transition_metric_type is equal to "image_pull". Note that these metrics are only emitted in the event that an image pull occurs, if imagePullPolicy is set to IfNotPresent this will only occur if the image is not already present on the node.

Property Type Title/Description
- already_present boolean Already Present
+ started_timestamp string Started Timestamp
- finished_timestamp string Finished Timestamp
- duration_seconds number Duration

1.32.1. Property Metric Record > kube_transition_metrics > image_pull > already_present

Title: Already Present
Type boolean
Required No

Description: true if the image was already present on the machine, otherwise false.

1.32.2. Property Metric Record > kube_transition_metrics > image_pull > started_timestamp

Title: Started Timestamp
Type string
Required Yes
Format date-time

Description: The timestamp for when the image pull was first initiated. This is obtained from the Event emitted by the Kubelet and may not be 100% accurate. In the event of ImagePullFailed this time is not reset for subsequent attempts.

1.32.3. Property Metric Record > kube_transition_metrics > image_pull > finished_timestamp

Title: Finished Timestamp
Type string
Required No
Format date-time

Description: The timestamp for when the image pull was finished. This is obtained from the Event emitted by the Kubelet and may not be 100% accurate.

1.32.4. Property Metric Record > kube_transition_metrics > image_pull > duration_seconds

Title: Duration
Type number
Required No

Description: The duration in seconds to complete the image pull successfully. This is based purely off the started_timestamp and finished_timestamp, which themselves are based on Event timestamps which are rounded to seconds. The duration here may not match perfectly the duration seen in the kubelet image pull message, due to slight latency in reporting of image pull Events and truncation of timestamps to seconds.

2. Property Metric Record > time

Title: Metric Timestamp
Type string
Required Yes
Format date-time

Description: The time at which this metric was emitted.

3. Property Metric Record > message

Title: Message
Type string
Required No

Description: An additional message emitted along with metrics.

Generated using json-schema-for-humans
⚡