List of Metrics#
This has the list of metrics which are available for usage. In many systems, only a subset of metrics get stored based on how they would be used.
Metric Tiers#
Importance is about storage, not stability: it says which metrics are worth keeping when capacity is limited, not what we promise about their names.
For that, see Stability Guarantees and Deprecation Policy — in short, mz_* names come from Materialize itself and we disclose rather than freeze them.
Metrics are grouped by “metricImportance” levels (mzmon-specific). These levels guide which metrics are prioritized in metric stores which have limited capacity.
The essential metrics are the set of metrics that are critical and you would always want to have available. These are used in alerting.
The recommended metrics are the set of metrics that are used in dashboards and are generally desirable for troubleshooting.
The extended set of metrics are used for optional/experimental dashboards.
The diagnostic set of metrics are used for in-depth troubleshooting and analysis.
In our materialize-monitoring configuration, we also
provide an all min-importance for including
absolutely everything.
This is recommended if you have cheaper metric storage
like our bundled Thanos provider.
Essential Metrics#
FIXME: Some links for alerts mistakenly point at the common-queries page.
- certmanager_certificate_ready_statusUsed labels: condition
Example queries: - cilium_bpf_map_pressure
Example queries: - cilium_drop_count_total
Example queries: - container_cpu_cfs_periods_totalUsed labels: container
Example queries: - container_cpu_cfs_throttled_periods_totalUsed labels: container
Example queries: - container_cpu_usage_seconds_totalUsed labels: container, namespace, pod
Example queries: - container_file_descriptorsUsed labels: container
Example queries: - container_fs_limit_bytes
Example queries: - container_fs_usage_bytes
Example queries: - container_last_seenUsed labels: materialize_cloud_swap
Example queries: - container_memory_swap
Example queries: - container_memory_working_set_bytesUsed labels: container, namespace, pod
Example queries:- infra.kubernetes.memory_elevated
- infra.kubernetes.memory_high
- materialize.environmentd.high_memory
- materialize.environmentd.memory_elevated
- materialize.generations.memory
- materialize.generations.pods
- materialize.kubernetes.memory.usage.absolute
- materialize.kubernetes.memory.usage.percent
- materialize.kubernetes.pods.memory_usage
- container_network_receive_bytes_totalUsed labels: namespace, pod, workload
Example queries: - container_network_receive_errors_totalUsed labels: namespace, pod
Example queries: - container_network_receive_packets_dropped_totalUsed labels: namespace, pod
Example queries: - container_network_transmit_bytes_totalUsed labels: namespace, pod
Example queries: - container_network_transmit_errors_totalUsed labels: namespace, pod
Example queries: - container_network_transmit_packets_dropped_totalUsed labels: namespace, pod
Example queries: - container_spec_cpu_periodUsed labels: container, namespace, pod
Example queries: - container_spec_cpu_quotaUsed labels: container, namespace, pod
Example queries: - container_spec_memory_limit_bytesUsed labels: container, namespace, pod
Example queries:- infra.kubernetes.memory_elevated
- infra.kubernetes.memory_high
- materialize.environmentd.high_memory
- materialize.environmentd.memory_elevated
- materialize.kubernetes.memory.capacity
- materialize.kubernetes.memory.capacity.all_containers
- materialize.kubernetes.memory.usage.percent
- materialize.kubernetes.pods.memory_usage
- container_spec_memory_swap_limit_bytes
Example queries: - container_start_time_secondsUsed labels: container, namespace
Example queries: - container_ulimits_softUsed labels: ulimit
Example queries: - coredns_dns_request_duration_seconds_bucketUsed labels: zone
Example queries: - crdb_dedicated_capacity
- crdb_dedicated_capacity_used
- crdb_dedicated_intentcount
- crdb_dedicated_ranges_underreplicated
Example queries: - crdb_dedicated_rocksdb_read_amplification
- crdb_dedicated_schedules_backup_last_completed_time
Example queries: - crdb_dedicated_sql_mem_distsql_current
- crdb_dedicated_sql_service_latency_bucket
Example queries: - crdb_dedicated_sys_cpu_combined_percent_normalized
- crdb_dedicated_sys_totalmem
Example queries: - kube_deployment_status_conditionUsed labels: condition, deployment, status
Example queries: - kube_deployment_status_replicas_readyUsed labels: namespace
Example queries: - kube_horizontalpodautoscaler_spec_max_replicasUsed labels: namespace
Example queries: - kube_horizontalpodautoscaler_status_current_replicasUsed labels: namespace
Example queries: - kube_node_createdUsed labels: node
Example queries: - kube_node_infoUsed labels: node
Example queries: - kube_node_spec_taintUsed labels: key, node
Example queries: - kube_node_spec_unschedulableUsed labels: node
Example queries: - kube_node_status_allocatableUsed labels: node, resource
Example queries: - kube_node_status_capacityUsed labels: node, resource
Example queries: - kube_node_status_conditionUsed labels: condition, node, status
Example queries: - kube_pod_container_resource_limitsUsed labels: namespace, node, pod, resource
Example queries: - kube_pod_container_resource_requestsUsed labels: container, namespace, node, pod, resource, unit
Example queries: - kube_pod_container_status_last_terminated_exitcodeUsed labels: container, pod
Example queries: - kube_pod_container_status_last_terminated_reasonUsed labels: container, namespace, reason
Example queries: - kube_pod_container_status_restarts_totalUsed labels: container, namespace
Example queries:- infra.kubernetes.oomkill_core_systems
- infra.kubernetes.oomkill_important_systems
- infra.kubernetes.oomkill_nonessential_systems
- infra.kubernetes.pod_restart_rate_high
- infra.kubernetes.pod_restart_rate_high_nonessential
- infra.nodes.pods.restarts
- materialize.clusterd.error_kill
- materialize.clusterd.new_restarts_during_release
- materialize.clusterd.swap_cluster_oom
- kube_pod_container_status_waiting
Example queries: - kube_pod_created
Example queries: - kube_pod_infoUsed labels: node
Example queries: - kube_pod_start_time
- kube_pod_status_phaseUsed labels: namespace, phase
Example queries: - kube_pod_status_readyUsed labels: condition
Example queries: - kube_statefulset_status_replicas_readyUsed labels: namespace
Example queries: - kubelet_node_nameUsed labels: workload
Example queries: - kubelet_volume_stats_capacity_bytesUsed labels: persistentvolumeclaim
Example queries: - kubelet_volume_stats_used_bytesUsed labels: persistentvolumeclaim
Example queries: - loki_distributor_bytes_received_totalUsed labels: namespace
Example queries: - loki_panic_total
Example queries: - loki_request_duration_seconds_bucketUsed labels: route
Example queries: - loki_request_duration_seconds_countUsed labels: route, status_code
Example queries: - loki_write_dropped_entries_total
Example queries: - mz_adapter_commandsUsed labels: application_name, materialize_cloud_organization_name, status
Example queries: - mz_auth_request_countUsed labels: path, status
Example queries: - mz_cluster_server_last_command_receivedUsed labels: pod, server_name
Example queries: - mz_dataflow_replica_expiration_remaining_secondsUsed labels: pod
Example queries: - mz_external_calls_countUsed labels: status
Example queries: - mz_external_envd_up
Example queries: - mz_memory_limiter_memory_limit_bytesUsed labels: pod
Example queries: - mz_memory_limiter_memory_usage_bytesUsed labels: pod
Example queries: - mz_parameter_frontend_last_cse_time_seconds
Example queries: - mz_parameter_frontend_last_sse_time_seconds
Example queries: - mz_persist_blob_failures
Example queries: - mz_persist_cmd_failed_count
Example queries: - mz_persist_columnar_op_countUsed labels: op, result
Example queries: - mz_persist_columnar_validation_countUsed labels: result
Example queries: - mz_persist_compaction_dropped
Example queries: - mz_persist_compaction_failed
Example queries: - mz_persist_compaction_noop
Example queries: - mz_persist_consensus_failures
Example queries: - mz_persist_external_blob_delete_noop_count
Example queries: - mz_persist_external_failed_count
Example queries: - mz_persist_lease_timeout_read
Example queries: - mz_persist_pushdown_parts_mismatched_stats_count
Example queries: - mz_persist_schema_cache_fetch_state_count
Example queries: - mz_persist_shard_unconsolidated_snapshot
Example queries: - mz_persist_state_update_state_slow_path
Example queries: - mz_shard_finalization_outstanding
Example queries: - mz_time_to_first_row_seconds_bucketUsed labels: application_name, instance_id
Example queries: - mz_txn_placeholder_schema_apply
Example queries: - node_boot_time_secondsUsed labels: instance
Example queries: - node_cpu_seconds_totalUsed labels: instance, mode
Example queries: - node_disk_io_time_seconds_totalUsed labels: instance
Example queries: - node_filefd_allocatedUsed labels: instance
Example queries: - node_filefd_maximumUsed labels: instance
Example queries: - node_filesystem_avail_bytesUsed labels: fstype, instance
Example queries: - node_filesystem_readonlyUsed labels: fstype, instance
Example queries: - node_filesystem_size_bytesUsed labels: fstype, instance
Example queries: - node_load1Used labels: instance
Example queries: - node_memory_MemAvailable_bytesUsed labels: instance
Example queries: - node_memory_MemTotal_bytesUsed labels: instance
Example queries: - node_memory_SwapFree_bytesUsed labels: instance
Example queries: - node_memory_SwapTotal_bytesUsed labels: instance
Example queries: - node_network_receive_bytes_totalUsed labels: device, instance
Example queries: - node_network_receive_drop_totalUsed labels: instance
Example queries: - node_network_receive_errs_totalUsed labels: instance
Example queries: - node_network_transmit_bytes_totalUsed labels: device, instance
Example queries: - node_network_transmit_drop_totalUsed labels: instance
Example queries: - node_network_transmit_errs_totalUsed labels: instance
Example queries: - node_nf_conntrack_entriesUsed labels: instance
Example queries: - node_nf_conntrack_entries_limitUsed labels: instance
Example queries: - node_pressure_cpu_waiting_seconds_totalUsed labels: instance
Example queries: - node_pressure_memory_stalled_seconds_totalUsed labels: instance
Example queries: - node_pressure_memory_waiting_seconds_totalUsed labels: instance
Example queries: - node_scrape_collector_successUsed labels: instance
Example queries: - node_time_secondsUsed labels: instance
Example queries: - node_vmstat_oom_killUsed labels: instance
Example queries: - node_vmstat_pswpinUsed labels: instance
Example queries: - node_vmstat_pswpoutUsed labels: instance
Example queries: - upUsed labels: cluster_environmentd_materialize_cloud_cluster_id, job, namespace
Example queries: - v2_mz_can_connect
- v2_mz_envd_up
Example queries: - v2_mz_views_query_successful
Recommended Metrics#
- environmentd_needs_updateUsed labels: namespace
Example queries: - mz_active_sessionsUsed labels: materialize_cloud_organization_name
Example queries: - mz_active_subscribesUsed labels: materialize_cloud_organization_name
Example queries: - mz_arrangement_maintenance_seconds_totalUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_arrangement_record_countUsed labels: collection_id, instance_id, materialize_cloud_organization_name, replica_id
Example queries: - mz_compute_cluster_statusUsed labels: compute_cluster_id, compute_replica_id, compute_replica_name, materialize_cloud_organization_name, pod
Example queries: - mz_compute_commands_totalUsed labels: materialize_cloud_organization_name, pod
Example queries: - mz_compute_controller_hydration_queue_sizeUsed labels: instance_id, materialize_cloud_organization_name, replica_id
Example queries: - mz_compute_hydration_time_secondsUsed labels: hydrated, instance_id, materialize_cloud_organization_name, replica_id
Example queries: - mz_compute_peek_duration_seconds_bucketUsed labels: instance_id, materialize_cloud_organization_name
Example queries: - mz_compute_replica_history_dataflow_countUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_dataflow_elapsed_seconds_totalUsed labels: instance_id, materialize_cloud_organization_name, replica_id
Example queries: - mz_dataflow_wallclock_lag_secondsUsed labels: instance_id, materialize_cloud_organization_name, pod, quantile, replica_id
Example queries:- materialize.compute.freshness.lag_by_cluster
- materialize.compute.freshness.lag_total_by_cluster
- materialize.compute.freshness.top_collections
- materialize.compute.hydration.currently_hydrating
- materialize.generations.collections
- materialize.generations.hydrating
- materialize.generations.lag.max
- materialize.generations.lag.total
- materialize.generations.lag.total_by_cluster
- materialize.info.max_lag
- mz_indexes_countUsed labels: materialize_cloud_organization_name
Example queries: - mz_mzd_views_countUsed labels: materialize_cloud_organization_name
Example queries: - mz_query_totalUsed labels: materialize_cloud_organization_name
Example queries: - mz_sink_bytes_committedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_bytes_stagedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_commit_conflictsUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_commit_duration_seconds_bucketUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_commit_failuresUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_data_files_writtenUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_delete_files_writtenUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_iceberg_snapshots_committedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_rdkafka_connectsUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_rdkafka_disconnectsUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_rdkafka_outbuf_msg_cntUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_sink_rdkafka_txerrsUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_source_bytes_receivedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_source_messages_receivedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_source_offset_commit_failuresUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_source_offset_committedUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_source_offset_knownUsed labels: cluster_environmentd_materialize_cloud_cluster_id, cluster_environmentd_materialize_cloud_replica_id, materialize_cloud_organization_name
Example queries: - mz_storage_objectsUsed labels: materialize_cloud_organization_name, type
Example queries: - mz_tables_countUsed labels: materialize_cloud_organization_name
Example queries: - mz_views_countUsed labels: materialize_cloud_organization_name
Example queries: - node_arp_entriesUsed labels: instance
Example queries: - node_context_switches_totalUsed labels: instance
Example queries: - node_disk_io_time_weighted_seconds_totalUsed labels: instance
Example queries: - node_disk_read_bytes_totalUsed labels: instance
Example queries: - node_disk_read_time_seconds_totalUsed labels: instance
Example queries: - node_disk_reads_completed_totalUsed labels: instance
Example queries: - node_disk_write_time_seconds_totalUsed labels: instance
Example queries: - node_disk_writes_completed_totalUsed labels: instance
Example queries: - node_disk_written_bytes_totalUsed labels: instance
Example queries: - node_entropy_available_bitsUsed labels: instance
Example queries: - node_entropy_pool_size_bitsUsed labels: instance
Example queries: - node_filesystem_filesUsed labels: fstype, instance
Example queries: - node_filesystem_files_freeUsed labels: fstype, instance
Example queries: - node_intr_totalUsed labels: instance
Example queries: - node_memory_Buffers_bytesUsed labels: instance
Example queries: - node_memory_Cached_bytesUsed labels: instance
Example queries: - node_memory_Committed_AS_bytesUsed labels: instance
Example queries: - node_memory_MemFree_bytesUsed labels: instance
Example queries: - node_memory_SReclaimable_bytesUsed labels: instance
Example queries: - node_memory_SUnreclaim_bytesUsed labels: instance
Example queries: - node_memory_Slab_bytesUsed labels: instance
Example queries: - node_netstat_TcpExt_ListenDropsUsed labels: instance
Example queries: - node_netstat_TcpExt_ListenOverflowsUsed labels: instance
Example queries: - node_netstat_TcpExt_TCPRcvQDropUsed labels: instance
Example queries: - node_netstat_TcpExt_TCPSynRetransUsed labels: instance
Example queries: - node_netstat_TcpExt_TCPTimeoutsUsed labels: instance
Example queries: - node_netstat_Tcp_OutSegsUsed labels: instance
Example queries: - node_netstat_Tcp_RetransSegsUsed labels: instance
Example queries: - node_netstat_Udp_InErrorsUsed labels: instance
Example queries: - node_netstat_Udp_NoPortsUsed labels: instance
Example queries: - node_netstat_Udp_RcvbufErrorsUsed labels: instance
Example queries: - node_network_carrierUsed labels: instance
Example queries: - node_network_speed_bytesUsed labels: instance
Example queries: - node_network_upUsed labels: instance
Example queries: - node_schedstat_waiting_seconds_totalUsed labels: instance
Example queries: - node_scrape_collector_duration_secondsUsed labels: instance
Example queries: - node_sockstat_TCP_allocUsed labels: instance
Example queries: - node_sockstat_TCP_inuseUsed labels: instance
Example queries: - node_sockstat_TCP_mem_bytesUsed labels: instance
Example queries: - node_sockstat_TCP_orphanUsed labels: instance
Example queries: - node_sockstat_TCP_twUsed labels: instance
Example queries: - node_sockstat_UDP_mem_bytesUsed labels: instance
Example queries: - node_softnet_dropped_totalUsed labels: instance
Example queries: - node_softnet_processed_totalUsed labels: instance
Example queries: - node_softnet_times_squeezed_totalUsed labels: instance
Example queries: - node_timex_estimated_error_secondsUsed labels: instance
Example queries: - node_timex_maxerror_secondsUsed labels: instance
Example queries: - node_timex_offset_secondsUsed labels: instance
Example queries: - node_timex_sync_statusUsed labels: instance
Example queries: - node_udp_queuesUsed labels: instance, ip, queue
Example queries: - node_vmstat_pgfaultUsed labels: instance
Example queries: - node_vmstat_pgmajfaultUsed labels: instance
Example queries: - node_vmstat_pgscan_directUsed labels: instance
Example queries: - node_vmstat_pgscan_kswapdUsed labels: instance
Example queries: - node_vmstat_pgsteal_directUsed labels: instance
Example queries: - node_vmstat_pgsteal_kswapdUsed labels: instance
Example queries: - orchestratord_is_leaderUsed labels: namespace
Example queries: - orchestratord_reconciliation_duration_seconds_bucketUsed labels: namespace
Example queries: - orchestratord_reconciliation_step_duration_seconds_bucketUsed labels: namespace
Example queries: - orchestratord_reconciliation_steps_totalUsed labels: namespace, outcome
Example queries: - orchestratord_reconciliations_total