Karpenter metrics documentation should be improved

hitsub2 commented 1 month ago

Description

How can the docs be improved? For examples, the following metrics documentation should be improved.

1.karpenter_nodes_termination_time_seconds

Examples

karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="celeborn-worker-graviton", quantile="0.9", service="karpenter"} 0.229906829
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="celeborn-worker-graviton", quantile="0.99", service="karpenter"} 0.229906829
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="celeborn-worker-graviton", quantile="1", service="karpenter"} 0.229906829
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-compute-optimized", quantile="0", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-compute-optimized", quantile="0.5", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-compute-optimized", quantile="0.9", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-compute-optimized", quantile="0.99", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-compute-optimized", quantile="1", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", quantile="0", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", quantile="0.5", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", quantile="0.9", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", quantile="0.99", service="karpenter"} NaN
karpenter_nodes_termination_time_seconds{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", quantile="1", service="karpenter"} NaN

Improvemen

A.what’s the quantile?

B.how can we know the node info?

2.karpenter_nodes_leases_deleted

Improvement

what's the leases?

3.Provisioner Metrics related metric are lost after migrated to nodepool

nodepool lacks of metric like karpenter_provisioner_scheduling_simulation_duration_seconds and karpenter_provisioner_scheduling_duration_seconds.

4.karpenter_nodeclaims_terminated

karpenter_nodeclaims_terminated{app_kubernetes_io_instance="karpenter", app_kubernetes_io_managed_by="Helm", app_kubernetes_io_name="karpenter", app_kubernetes_io_version="0.36.0", helm_sh_chart="karpenter-0.36.0", instance="100.64.81.229:8000", job="kubernetes-service-endpoints", kubernetes_namespace="karpenter", nodepool="spark-memory-optimized", reason="insufficient_capacity", service="karpenter"} 1

Improvemen

what’s the reason for insufficient_capacity？

5.disruption metrics

karpenter_nodeclaims_disrupted

Improvemen

what’s disruption?

6.karpenter_interruption_received_messages

Improvemen

how many reasons for interruption(message type) for interruption?

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
If you are interested in working on this issue or have submitted a pull request, please leave a comment

engedaam commented 1 month ago

A.what’s the quantile?

https://prometheus.io/docs/practices/histograms/#quantiles

B.how can we know the node info?

What information are you expecting? https://karpenter.sh/docs/reference/metrics/#nodes-metrics

3.Provisioner Metrics related metric are lost after migrated to nodepool nodepool lacks of metric like karpenter_provisioner_scheduling_simulation_duration_seconds and karpenter_provisioner_scheduling_duration_seconds.

https://karpenter.sh/docs/reference/metrics/#provisioner-metrics

B. what's the leases?

https://kubernetes.io/docs/concepts/architecture/leases/#node-heart-beats

C. what’s disruption?

https://karpenter.sh/docs/concepts/disruption/

D. what’s the reason for insufficient_capacity？

The cloud provider does not have sufficient capacity to fulfill you request

github-actions[bot] commented 3 weeks ago

This issue has been inactive for 14 days. StaleBot will close this stale issue after 14 more days of inactivity.

aws / karpenter-provider-aws