YugabyteDB Managed

Supported OS Linux

Overview

YugabyteDB is a cloud-native, distributed database that is API compatible with PostgreSQL.

YugabyteDB Managed is YugabyteDB’s fully-managed Database-as-a-service (DBaaS). With this integration, you can send your cluster metrics to Datadog for visibility into the health and performance of your YugabyteDB Managed clusters. This integration comes with an out-of-the-box dashboard to provide visibility into all the most important metrics needed to monitor the health and performance of a YugabyteDB Managed cluster such as:

  • Node resource usage (disk, memory, CPU, networking, and more).
  • Read/write operation throughput and latencies (both YSQL and YCQL).
  • Advanced Master and Tablet Server telemetry (for example, internal RPC throughput/latencies and WAL read/write throughput).

Setup

Note: This feature is not available for Sandbox Clusters.

Installation

To enable the YugabyteDB Managed integration with Datadog:

Create a configuration

  1. In YugabyteDB Managed, navigate to the Integrations > Metrics tab.
  2. Click Create Export Configuration or Add Export Configuration.
  3. Select the Datadog provider.
  4. Fill in the API key and Site fields with the corresponding values. For more information, see the Datadog API and Application Keys and Datadog Site URL documentation.
  5. Click Test Configuration to validate the configuration.
  6. Click Create Configuration.

Associate a configuration to a cluster

  1. In YugabyteDB Managed, navigate to the Integrations > Metrics tab.
  2. Find your cluster in the Export Metrics by Cluster table.
  3. Select the desired configuration from the Export Configuration dropdown menu.
  4. Wait for the Export Status to show Active.

Note: Your cluster cannot associate a configuration when paused or when another operation is in progress.

For more information on setup, see the YugabyteDB documentation.

Uninstallation

To disable metrics being exported to Datadog:

  1. In YugabyteDB Managed, navigate to the Integrations > Metrics tab.
  2. Find your cluster in the Export Metrics by Cluster table.
  3. Open the dropdown for your cluster under the Export Configuration dropdown and select None.
  4. Wait for the Export Status to show -.

Note: Your cluster cannot associate a configuration when paused or when another operation is in progress.

Data Collected

Metrics

ybdb.automatic_split_manager_time
(gauge)
ybdb.block_cache_multi_touch_usage
(gauge)
ybdb.block_cache_single_touch_usage
(gauge)
ybdb.cpu_stime
(gauge)
ybdb.cpu_utime
(gauge)
ybdb.expired_transactions
(gauge)
ybdb.follower_lag_ms
(gauge)
ybdb.follower_memory_pressure_rejections
(gauge)
ybdb.generic_current_allocated_bytes
(gauge)
ybdb.generic_heap_size
(gauge)
ybdb.glog_error_messages
(gauge)
ybdb.glog_info_messages
(gauge)
ybdb.glog_warning_messages
(gauge)
ybdb.handler_latency_outbound_call_queue_time_count
(gauge)
ybdb.handler_latency_outbound_call_queue_time_sum
(gauge)
ybdb.handler_latency_outbound_transfer_count
(gauge)
ybdb.handler_latency_outbound_transfer_sum
(gauge)
ybdb.hybrid_clock_skew
(gauge)
ybdb.involuntary_context_switches
(gauge)
ybdb.leader_memory_pressure_rejections
(gauge)
ybdb.log_append_latency_count
(gauge)
ybdb.log_append_latency_sum
(gauge)
ybdb.log_bytes_logged
(gauge)
ybdb.log_cache_num_ops
(gauge)
ybdb.log_cache_size
(gauge)
ybdb.log_group_commit_latency_count
(gauge)
ybdb.log_group_commit_latency_sum
(gauge)
ybdb.log_reader_bytes_read
(gauge)
ybdb.log_sync_latency_count
(gauge)
ybdb.log_sync_latency_sum
(gauge)
ybdb.majority_sst_files_rejections
(gauge)
ybdb.node_cpu_seconds_total
(gauge)
ybdb.node_disk_read_bytes_total
(gauge)
ybdb.node_disk_reads_completed_total
(gauge)
ybdb.node_disk_writes_completed_total
(gauge)
ybdb.node_disk_written_bytes_total
(gauge)
ybdb.node_filesystem_free_bytes
(gauge)
ybdb.node_filesystem_size_bytes
(gauge)
ybdb.node_memory_MemAvailable_bytes
(gauge)
ybdb.node_memory_MemTotal_bytes
(gauge)
ybdb.node_network_receive_bytes_total
(gauge)
ybdb.node_network_receive_errs_total
(gauge)
ybdb.node_network_receive_packets_total
(gauge)
ybdb.node_network_transmit_bytes_total
(gauge)
ybdb.node_network_transmit_errs_total
(gauge)
ybdb.node_network_transmit_packets_total
(gauge)
ybdb.operation_memory_pressure_rejections
(gauge)
ybdb.rocksdb_block_cache_hit
(gauge)
ybdb.rocksdb_block_cache_miss
(gauge)
ybdb.rocksdb_bloom_filter_checked
(gauge)
ybdb.rocksdb_bloom_filter_useful
(gauge)
ybdb.rocksdb_compact_read_bytes
(gauge)
ybdb.rocksdb_compact_write_bytes
(gauge)
ybdb.rocksdb_compaction_times_micros_count
(gauge)
ybdb.rocksdb_compaction_times_micros_sum
(gauge)
ybdb.rocksdb_current_version_num_sst_files
(gauge)
ybdb.rocksdb_current_version_sst_files_size
(gauge)
ybdb.rocksdb_db_get_micros_count
(gauge)
ybdb.rocksdb_db_get_micros_sum
(gauge)
ybdb.rocksdb_db_seek_micros_count
(gauge)
ybdb.rocksdb_db_seek_micros_sum
(gauge)
ybdb.rocksdb_db_write_micros_count
(gauge)
ybdb.rocksdb_db_write_micros_sum
(gauge)
ybdb.rocksdb_flush_write_bytes
(gauge)
ybdb.rocksdb_number_db_next
(gauge)
ybdb.rocksdb_number_db_prev
(gauge)
ybdb.rocksdb_number_db_seek
(gauge)
ybdb.rocksdb_numfiles_in_singlecompaction_count
(gauge)
ybdb.rocksdb_numfiles_in_singlecompaction_sum
(gauge)
ybdb.rocksdb_stall_micros
(gauge)
ybdb.rpc_connections_alive
(gauge)
ybdb.rpc_inbound_calls_created
(gauge)
ybdb.rpc_incoming_queue_time_count
(gauge)
ybdb.rpc_incoming_queue_time_sum
(gauge)
ybdb.rpc_latency
(gauge)
ybdb.rpc_latency_count
(gauge)
ybdb.rpc_latency_sum
(gauge)
ybdb.rpcs_in_queue_yb_cdc_CDCService
(gauge)
ybdb.rpcs_in_queue_yb_consensus_ConsensusService
(gauge)
ybdb.rpcs_in_queue_yb_cqlserver_CQLServerService
(gauge)
ybdb.rpcs_in_queue_yb_master_MasterBackup
(gauge)
ybdb.rpcs_in_queue_yb_master_MasterService
(gauge)
ybdb.rpcs_in_queue_yb_server_GenericService
(gauge)
ybdb.rpcs_in_queue_yb_tserver_PgClientService
(gauge)
ybdb.rpcs_in_queue_yb_tserver_RemoteBootstrapService
(gauge)
ybdb.rpcs_in_queue_yb_tserver_TabletServerAdminService
(gauge)
ybdb.rpcs_in_queue_yb_tserver_TabletServerBackupService
(gauge)
ybdb.rpcs_in_queue_yb_tserver_TabletServerService
(gauge)
ybdb.spinlock_contention_time
(gauge)
ybdb.threads_running
(gauge)
ybdb.threads_started
(gauge)
ybdb.transaction_conflicts
(gauge)
ybdb.transaction_pool_cache_count
(gauge)
ybdb.transaction_pool_cache_sum
(gauge)
ybdb.ts_post_split_compaction_added
(gauge)
ybdb.ts_split_op_added
(gauge)
ybdb.ts_split_op_apply
(gauge)
ybdb.up
(gauge)
ybdb.voluntary_context_switches
(gauge)
ybdb.yb_node_boot_time
(gauge)
ybdb.yb_node_version_check
(gauge)
ybdb.yb_node_ycql_connect
(gauge)
ybdb.yb_node_ysql_connect
(gauge)
ybdb.yb_ysqlserver_connection_total
(gauge)

Service Checks

YugabyteDB Managed does not include any service checks.

Events

YugabyteDB Managed does not include any events.

Support

Need help? Contact YugabyteDB support.

PREVIEWING: Cyril-Bouchiat/add-vm-package-explorer-doc