Search
⌃K

Supported metrics

Explore the unlimited granularity our metrics can offer.

Quick Start

The easiest way to explore the metrics you can use to build your custom dashboard is by using the Metrics browser: 1️⃣ Go to one of example dashboards in the Dashboards by groundcover folder.
2️⃣ Right-click any panel and press Explore.
3️⃣ Press the Metrics browser drop-down button to see all available metrics and their labels

Our Labels

Supporting high granularity labels for maximal insight depth.
clusterId Name identifier of the K8s cluster
region cloud provider region name
namespace K8s namespace
node_name K8s node name
workload_name K8s workload (or service) name
pod_name K8s pod name
container_name K8s container name
container_image K8s container image name
type The protocol in use (possible values are: HTTP, gRPC, Kafka, DNS etc.)
role Role in the communication (possible values are: client or server)
clustered_path HTTP / gRPC aggregated resource path (e.g. /metrics/*)
method HTTP method (e.g GET)
dialect SQL dialect (possible values are: MySQL or PostgreSQL)
client_type Type of Kafka client (Fetcher / Producer)
deployment_event_type K8s deployment type (possible values are: Added, Deleted or Updated)
error_code Kafka return status code
exit_code K8s container termination exit code
response_return_code return status code of a DNS resolution request (e.g. Name Error)
response_status return status code of a SQL query (e.g 42P01 for undefined table)
response_status_code return status code of a HTTP / gPRC request (e.g. 200 in HTTP)
topic Kafka topic name
partition Kafka partition identifier
query_type type of DNS query (e.g. AAAA)
remote_addr remote IP address (other side of the communication)
remote_container_name remote K8s container name (other side of the communication)
remote_namespace remote K8s namespace (other side of the communication)
remote_service_name remote K8s service name (other side of the communication)
state K8s container current state (possible values are: Running, Waiting or Terminated)
state_reason K8s container state transition reason (e.g CrashLoopBackOff or OOMKilled)
Summary based metrics have an additional quantile label, representing the percentile. Available values: [”0.5”, “0.95”, 0.99”].
​groundcover uses a set of internal labels which are not relevant in most use-cases. Find them interesting? great, let’s talk it over.
issue_id entity_id resource_id query_id aggregation_id parent_entity_id perspective_entity_id perspective_entity_is_external perspective_entity_issue_id perspective_entity_name perspective_entity_namespace perspective_entity_resource_id

Golden Signals Metrics

Monitoring of HTTP / gRPC / Kafka / SQL / DNS / Container events golden signals (error rate, throughput, latency, volume).

Available Labels

type role clustered_path method dialect query_type
clusterId region namespace node_name workload_name
container_name container_image
remote_namespace remote_service_name
response_status exit_code state state_reason

Available Metrics

Name
Description
Type
groundcover_resource_total_couner
total counter of resource requests
Counter
groundcover_resource_error_counter
total counter of resource requests with error status codes
Counter
groundcover_resource_success_counter
total counter of resource requests with OK status codes
Counter
groundcover_resource_latency_seconds_gauge
current resource latency (s)
Gauge
groundcover_resource_latency_seconds
resource latency (s)
Summary
groundcover_resource_latency_seconds_total
total resource latency so far (s)
Counter

Resource Payload Metrics

Monitoring of gRPC / HTTP / Kafka & MySQL / PostgreSQL payload sizes

Available Labels

type client_type role
clustered_path method dialect topic partition
clusterId region namespace node_name workload_name
container_name container_image
remote_namespace remote_service_name remote_container_name
response_status_code response_status error_code

Available Metrics

Name
Description
Type
groundcover_req_body_size_bytes_gauge
current resource request body size (B) *(HTTP / gRPC / Kafka)
Gauge
groundcover_req_body_size_bytes
resource request body size (B) **(HTTP / gRPC / Kafka)
Summary
groundcover_req_body_size_bytes_total
total resource request body size so far (B) **(HTTP / gRPC / Kafka)
Counter
groundcover_req_size_bytes_gauge
current resource request body size (B) **(SQL)
Gauge
groundcover_req_size_bytes
resource request body size (B) ) **(SQL)
Summary
groundcover_req_size_bytes_total
total resource request body size so far (B) ) **(SQL)
Counter
groundcover_resp_body_size_bytes_gauge
current resource response body size (B) *(HTTP / gRPC / Kafka)
Gauge
groundcover_resp_body_size_bytes
resource response body size (B) **(HTTP / gRPC / Kafka)
Summary
groundcover_resp_body_size_bytes_total
total resource response body size so far (B) **(HTTP / gRPC / Kafka)
Counter
groundcover_resp_size_bytes_gauge
current resource response body size (B) **(SQL)
Gauge
groundcover_resp_size_bytes
resource response body size (B) ) **(SQL)
Summary
groundcover_resp_size_bytes_total
total resource response body size so far (B) ) **(SQL)
Counter

Kafka-specific Metrics

Monitoring of Kafka performance (producers and consumers), capturing lags in messages and time, operation latency and traffic volume.

Available Labels

type client_type role
topic partition
clusterId region namespace node_name workload_name
container_name container_image
remote_service_name
error_code

Available Metrics

Name
Description
Type
groundcover_client_offset
client last message offset (for producer the last offset produced, for consumer the last requested offset)
Gauge
groundcover_calc_lagged_messages
current lag in messages
Gauge
groundcover_calc_lag_seconds_gauge
current lag in time (s)
Gauge
groundcover_calc_lag_seconds
lag in time (s)
Summary
groundcover_calc_lag_seconds_total
total lag in time so far (s)
Counter

Infrastructure Metrics

Monitoring host performance by container (CPU / memory utilization etc.)

Available Labels

type
clusterId region namespace node_name workload_name
pod_name container_name container_image

Available Metrics

​

Name
Description
Type
groundcover_container_m_cpu_usage_seconds_total
cumulative cpu time consumed (mCPU * seconds)
Gauge
groundcover_container_cpu_request_m_cpu
K8s container vlimit (mCPU)
Gauge
groundcover_container_cpu_limit_m_cpu
K8s container CPU limit (mCPU)
Gauge
groundcover_container_mem_working_set_bytes
current memory working set (B)
Gauge
groundcover_container_memory_request_bytes
K8s container memory request (B)
Gauge
groundcover_container_memory_limit_bytes
K8s container memory limit (B)
Gauge
groundcover_node_allocatable_cpum_cpu
amount of allocatable CPU in the current node (mCPU)
Gauge
groundcover_node_allocatable_mem_bytes
amount of allocatable memory in the current node (B)
Gauge

​

Use groundcover - Previous
Custom Dashboards
Next - Use groundcover
Custom Metrics
Last modified 2mo ago