Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update metrics #424

Merged
merged 1 commit into from
Jul 19, 2023
Merged

Update metrics #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions docs/reference/instrumentation/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,30 +7,30 @@ title: Karmada Metrics Reference
This section details the metrics that different Karmada components export.
You can query the metrics endpoint for these components using an HTTP scrape, and fetch the current metrics data in Prometheus format.

| Name | Type | Help | Labels | Source Components |
|--------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|----------------------------------------------|
| schedule_attempts_total | Counter | Number of attempts to schedule resourceBinding. | result<br/>schedule_type | karmada-scheduler |
| e2e_scheduling_duration_seconds | Histogram | E2E scheduling latency in seconds. | result<br/>schedule_type | karmada-scheduler |
| scheduling_algorithm_duration_seconds | Histogram | Scheduling algorithm latency in seconds(excluding scale scheduler). | schedule_step | karmada-scheduler |
| queue_incoming_bindings_total | Counter | Number of bindings added to scheduling queues by event type. | event | karmada-scheduler |
| framework_extension_point_duration_seconds | Histogram | Latency for running all plugins of a specific extension point. | extension_point<br/>result | karmada-scheduler |
| plugin_execution_duration_seconds | Histogram | Duration for running a plugin at a specific extension point. | plugin<br/>extension_point<br/>result | karmada-scheduler |
| estimating_request_total | Counter | Number of scheduler estimator requests. | result<br/>type | karmada_scheduler_estimator |
| estimating_algorithm_duration_seconds | Histogram | Estimating algorithm latency in seconds for each step. | result<br/>type<br/>step | karmada_scheduler_estimator |
| cluster_ready_state | Gauge | State of the cluster(1 if ready, 0 otherwise). | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_node_number | Gauge | Number of nodes in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_ready_node_number | Gauge | Number of ready nodes in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_memory_allocatable_bytes | Gauge | Allocatable cluster memory resource in bytes. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_cpu_allocatable_number | Gauge | Number of allocatable CPU in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_pod_allocatable_number | Gauge | Number of allocatable pods in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_memory_allocated_bytes | Gauge | Allocated cluster memory resource in bytes. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_cpu_allocated_number | Gauge | Number of allocated CPU in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_pod_allocated_number | Gauge | Number of allocated pods in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_sync_status_duration_seconds | Histogram | Duration in seconds for syncing the status of the cluster once. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| resource_match_policy_duration_seconds | Histogram | Duration in seconds to find a matched propagation policy for the resource template. | apiVersion<br/>kind<br/>name<br/>namespace | karmada-controller-manager |
| resource_apply_policy_duration_seconds | Histogram | Duration in seconds to apply a propagation policy for the resource template. By the result, 'error' means a resource template failed to apply the policy. Otherwise 'success'. | apiVersion<br/>kind<br/>name<br/>namespace<br/>result | karmada-controller-manager |
| policy_apply_attempts_total | Counter | Number of attempts to be applied for a propagation policy. By the result, 'error' means a resource template failed to apply the policy. Otherwise 'success'. | namespace<br/>name<br/>result | karmada-controller-manager |
| binding_sync_work_duration_seconds | Histogram | Duration in seconds to sync works for a binding object. By the result, 'error' means a binding failed to sync works. Otherwise 'success'. | namespace<br/>name<br/>result | karmada-controller-manager |
| work_sync_workload_duration_seconds | Histogram | Duration in seconds to sync the workload to a target cluster. By the result, 'error' means a work failed to sync workloads. Otherwise 'success'. | namespace<br/>name<br/>result | karmada-controller-manager<br/>karmada-agent |
| pool_get_operation_total | Counter | Total times of getting from pool | name<br/>from | karmada-controller-manager<br/>karmada-agent |
| pool_put_operation_total | Counter | Total times of putting from pool | name<br/>to | karmada-controller-manager<br/>karmada-agent |
| Name | Type | Help | Labels | Source Components |
| ------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | -------------------------------------------- |
| schedule_attempts_total | Counter | Number of attempts to schedule resourceBinding. | result<br/>schedule_type | karmada-scheduler |
| e2e_scheduling_duration_seconds | Histogram | E2E scheduling latency in seconds. | result<br/>schedule_type | karmada-scheduler |
| scheduling_algorithm_duration_seconds | Histogram | Scheduling algorithm latency in seconds(excluding scale scheduler). | schedule_step | karmada-scheduler |
| queue_incoming_bindings_total | Counter | Number of bindings added to scheduling queues by event type. | event | karmada-scheduler |
| framework_extension_point_duration_seconds | Histogram | Latency for running all plugins of a specific extension point. | extension_point<br/>result | karmada-scheduler |
| plugin_execution_duration_seconds | Histogram | Duration for running a plugin at a specific extension point. | plugin<br/>extension_point<br/>result | karmada-scheduler |
| estimating_request_total | Counter | Number of scheduler estimator requests. | result<br/>type | karmada_scheduler_estimator |
| estimating_algorithm_duration_seconds | Histogram | Estimating algorithm latency in seconds for each step. | result<br/>type<br/>step | karmada_scheduler_estimator |
| cluster_ready_state | Gauge | State of the cluster(1 if ready, 0 otherwise). | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_node_number | Gauge | Number of nodes in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_ready_node_number | Gauge | Number of ready nodes in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_memory_allocatable_bytes | Gauge | Allocatable cluster memory resource in bytes. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_cpu_allocatable_number | Gauge | Number of allocatable CPU in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_pod_allocatable_number | Gauge | Number of allocatable pods in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_memory_allocated_bytes | Gauge | Allocated cluster memory resource in bytes. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_cpu_allocated_number | Gauge | Number of allocated CPU in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_pod_allocated_number | Gauge | Number of allocated pods in the cluster. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| cluster_sync_status_duration_seconds | Histogram | Duration in seconds for syncing the status of the cluster once. | cluster_name | karmada-controller-manager<br/>karmada-agent |
| resource_match_policy_duration_seconds | Histogram | Duration in seconds to find a matched propagation policy for the resource template. | / | karmada-controller-manager |
| resource_apply_policy_duration_seconds | Histogram | Duration in seconds to apply a propagation policy for the resource template. By the result, 'error' means a resource template failed to apply the policy. Otherwise 'success'. | result | karmada-controller-manager |
| policy_apply_attempts_total | Counter | Number of attempts to be applied for a propagation policy. By the result, 'error' means a resource template failed to apply the policy. Otherwise 'success'. | result | karmada-controller-manager |
| binding_sync_work_duration_seconds | Histogram | Duration in seconds to sync works for a binding object. By the result, 'error' means a binding failed to sync works. Otherwise 'success'. | result | karmada-controller-manager |
| work_sync_workload_duration_seconds | Histogram | Duration in seconds to sync the workload to a target cluster. By the result, 'error' means a work failed to sync workloads. Otherwise 'success'. | result | karmada-controller-manager<br/>karmada-agent |
| pool_get_operation_total | Counter | Total times of getting from pool | name<br/>from | karmada-controller-manager<br/>karmada-agent |
| pool_put_operation_total | Counter | Total times of putting from pool | name<br/>to | karmada-controller-manager<br/>karmada-agent |
Loading