From d47e5803327b11bdb28e0fdff820bbd1a9159f95 Mon Sep 17 00:00:00 2001 From: Vincent Mercier Date: Sat, 7 Oct 2023 09:58:39 +0200 Subject: [PATCH] feat(README): Add metrics label --- README.md | 140 +++++++++++++++++++++++++++--------------------------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index efc9428..8310994 100644 --- a/README.md +++ b/README.md @@ -32,80 +32,80 @@ It collect key metrics about: ## Metrics -| Name | Description | -| ------ | ----------- | -| rds_allocated_storage_bytes | Allocated storage | -| rds_api_call_total | Number of call to AWS API | -| rds_backup_retention_period_seconds | Automatic DB snapshots retention period | -| rds_cpu_usage_percent_average | Instance CPU used | -| rds_database_connections_average | The number of client network connections to the database instance | -| rds_dbload_average | Number of active sessions for the DB engine | -| rds_dbload_cpu_average | Number of active sessions where the wait event type is CPU | -| rds_dbload_noncpu_average | Number of active sessions where the wait event type is not CPU | -| rds_exporter_build_info | A metric with constant '1' value labeled by version from which exporter was built | -| rds_exporter_errors_total | Total number of errors encountered by the exporter | -| rds_free_storage_bytes | Free storage on the instance | -| rds_freeable_memory_bytes | Amount of available random access memory. For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, this metric reports the value of the MemAvailable field of /proc/meminfo | -| rds_instance_info | RDS instance information | -| rds_instance_log_files_size_bytes | Total of log files on the instance | -| rds_instance_maxIops_average | Maximum IOPS of underlying EC2 instance | -| rds_instance_max_throughput_bytes | Maximum throughput of underlying EC2 instance | -| rds_instance_memory_bytes | Instance memory | -| rds_instance_status | Instance status (1: ok, 0: can't scrap metrics) | -| rds_instance_vcpu_average | Total vCPU for this isntance class | -| rds_max_allocated_storage_bytes | Upper limit in gibibytes to which Amazon RDS can automatically scale the storage of the DB instance | -| rds_max_disk_iops_average | Max IOPS for the instance | -| rds_max_storage_throughput_bytes | Max storage throughput | -| rds_maximum_used_transaction_ids_average | Maximum transaction IDs that have been used. Applies to only PostgreSQL | -| rds_quota_max_dbinstances_average | Maximum number of RDS instances allowed in the AWS account | -| rds_quota_maximum_db_instance_snapshots_average | Maximum number of manual DB instance snapshots | -| rds_quota_total_storage_bytes | Maximum total storage for all DB instances | -| rds_read_iops_average | Average number of disk read I/O operations per second | -| rds_read_throughput_bytes | Average number of bytes read from disk per second | -| rds_replica_lag_seconds | For read replica configurations, the amount of time a read replica DB instance lags behind the source DB instance. Applies to MariaDB, Microsoft SQL Server, MySQL, Oracle, and PostgreSQL read replicas | -| rds_replication_slot_disk_usage_average | Disk space used by replication slot files. Applies to PostgreSQL | -| rds_swap_usage_bytes | Amount of swap space used on the DB instance. This metric is not available for SQL Server | -| rds_usage_allocated_storage_average | Total storage used by AWS RDS instances | -| rds_usage_db_instances_average | AWS RDS instance count | -| rds_usage_manual_snapshots_average | Manual snapshots count | -| rds_write_iops_average | Average number of disk write I/O operations per second | -| rds_write_throughput_bytes | Average number of bytes written to disk per second | -| up | Was the last scrape of RDS successful | +| Name | Labels | Description | +| ---- | ------ | ----------- | +| rds_allocated_storage_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Allocated storage | +| rds_api_call_total | `api`, `aws_account_id`, `aws_region` | Number of call to AWS API | +| rds_backup_retention_period_seconds | `aws_account_id`, `aws_region`, `dbidentifier` | Automatic DB snapshots retention period | +| rds_cpu_usage_percent_average | `aws_account_id`, `aws_region`, `dbidentifier` | Instance CPU used | +| rds_database_connections_average | `aws_account_id`, `aws_region`, `dbidentifier` | The number of client network connections to the database instance | +| rds_dbload_average | `aws_account_id`, `aws_region`, `dbidentifier` | Number of active sessions for the DB engine | +| rds_dbload_cpu_average | `aws_account_id`, `aws_region`, `dbidentifier` | Number of active sessions where the wait event type is CPU | +| rds_dbload_noncpu_average | `aws_account_id`, `aws_region`, `dbidentifier` | Number of active sessions where the wait event type is not CPU | +| rds_exporter_build_info | `build_date`, `commit_sha`, `version` | A metric with constant '1' value labeled by version from which exporter was built | +| rds_exporter_errors_total | | Total number of errors encountered by the exporter | +| rds_free_storage_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Free storage on the instance | +| rds_freeable_memory_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Amount of available random access memory. For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, this metric reports the value of the MemAvailable field of /proc/meminfo | +| rds_instance_info | `aws_account_id`, `aws_region`, `dbi_resource_id`, `dbidentifier`, `deletion_protection`, `engine`, `engine_version`, `instance_class`, `multi_az`, `pending_maintenance`, `pending_modified_values`, `role`, `source_dbidentifier`, `storage_type` | RDS instance information | +| rds_instance_log_files_size_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Total of log files on the instance | +| rds_instance_maxIops_average | `aws_account_id`, `aws_region`, `dbidentifier` | Maximum IOPS of underlying EC2 instance | +| rds_instance_max_throughput_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Maximum throughput of underlying EC2 instance | +| rds_instance_memory_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Instance memory | +| rds_instance_status | `aws_account_id`, `aws_region`, `dbidentifier` | Instance status (1: ok, 0: can't scrap metrics) | +| rds_instance_vcpu_average | `aws_account_id`, `aws_region`, `dbidentifier` | Total vCPU for this isntance class | +| rds_max_allocated_storage_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Upper limit in gibibytes to which Amazon RDS can automatically scale the storage of the DB instance | +| rds_max_disk_iops_average | `aws_account_id`, `aws_region`, `dbidentifier` | Max IOPS for the instance | +| rds_max_storage_throughput_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Max storage throughput | +| rds_maximum_used_transaction_ids_average | `aws_account_id`, `aws_region`, `dbidentifier` | Maximum transaction IDs that have been used. Applies to only PostgreSQL | +| rds_quota_max_dbinstances_average | `aws_account_id`, `aws_region`, | Maximum number of RDS instances allowed in the AWS account | +| rds_quota_maximum_db_instance_snapshots_average | `aws_account_id`, `aws_region` | Maximum number of manual DB instance snapshots | +| rds_quota_total_storage_bytes | `aws_account_id`, `aws_region` | Maximum total storage for all DB instances | +| rds_read_iops_average | `aws_account_id`, `aws_region`, `dbidentifier` | Average number of disk read I/O operations per second | +| rds_read_throughput_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Average number of bytes read from disk per second | +| rds_replica_lag_seconds | `aws_account_id`, `aws_region`, `dbidentifier` | For read replica configurations, the amount of time a read replica DB instance lags behind the source DB instance. Applies to MariaDB, Microsoft SQL Server, MySQL, Oracle, and PostgreSQL read replicas | +| rds_replication_slot_disk_usage_average | `aws_account_id`, `aws_region`, `dbidentifier` | Disk space used by replication slot files. Applies to PostgreSQL | +| rds_swap_usage_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Amount of swap space used on the DB instance. This metric is not available for SQL Server | +| rds_usage_allocated_storage_average | `aws_account_id`, `aws_region` | Total storage used by AWS RDS instances | +| rds_usage_db_instances_average | `aws_account_id`, `aws_region` | AWS RDS instance count | +| rds_usage_manual_snapshots_average | `aws_account_id`, `aws_region` | Manual snapshots count | +| rds_write_iops_average | `aws_account_id`, `aws_region`, `dbidentifier` | Average number of disk write I/O operations per second | +| rds_write_throughput_bytes | `aws_account_id`, `aws_region`, `dbidentifier` | Average number of bytes written to disk per second | +| up | | Was the last scrape of RDS successful |
Standard Go and Prometheus metrics are also available -| Name | Description | -| ------ | ----------- | -| go_gc_duration_seconds | A summary of the pause duration of garbage collection cycles. | -| go_goroutines | Number of goroutines that currently exist. | -| go_info | Information about the Go environment. | -| go_memstats_alloc_bytes | Number of bytes allocated and still in use. | -| go_memstats_alloc_bytes_total | Total number of bytes allocated, even if freed. | -| go_memstats_buck_hash_sys_bytes | Number of bytes used by the profiling bucket hash table. | -| go_memstats_frees_total | Total number of frees. | -| go_memstats_gc_sys_bytes | Number of bytes used for garbage collection system metadata. | -| go_memstats_heap_alloc_bytes | Number of heap bytes allocated and still in use. | -| go_memstats_heap_idle_bytes | Number of heap bytes waiting to be used. | -| go_memstats_heap_inuse_bytes | Number of heap bytes that are in use. | -| go_memstats_heap_objects | Number of allocated objects. | -| go_memstats_heap_released_bytes | Number of heap bytes released to OS. | -| go_memstats_heap_sys_bytes | Number of heap bytes obtained from system. | -| go_memstats_last_gc_time_seconds | Number of seconds since 1970 of last garbage collection. | -| go_memstats_lookups_total | Total number of pointer lookups. | -| go_memstats_mallocs_total | Total number of mallocs. | -| go_memstats_mcache_inuse_bytes | Number of bytes in use by mcache structures. | -| go_memstats_mcache_sys_bytes | Number of bytes used for mcache structures obtained from system. | -| go_memstats_mspan_inuse_bytes | Number of bytes in use by mspan structures. | -| go_memstats_mspan_sys_bytes | Number of bytes used for mspan structures obtained from system. | -| go_memstats_next_gc_bytes | Number of heap bytes when next garbage collection will take place. | -| go_memstats_other_sys_bytes | Number of bytes used for other system allocations. | -| go_memstats_stack_inuse_bytes | Number of bytes in use by the stack allocator. | -| go_memstats_stack_sys_bytes | Number of bytes obtained from system for stack allocator. | -| go_memstats_sys_bytes | Number of bytes obtained from system. | -| go_threads | Number of OS threads created. | -| promhttp_metric_handler_requests_in_flight | Current number of scrapes being served. | -| promhttp_metric_handler_requests_total | Total number of scrapes by HTTP status code. | +| Name | Labels | Description | +| ------ | -------| ----------- | +| go_gc_duration_seconds | `quantile` | A summary of the pause duration of garbage collection cycles. | +| go_goroutines | | umber of goroutines that currently exist. | +| go_info | `version` | Information about the Go environment. | +| go_memstats_alloc_bytes | | Number of bytes allocated and still in use. | +| go_memstats_alloc_bytes_total | | Total number of bytes allocated, even if freed. | +| go_memstats_buck_hash_sys_bytes | | Number of bytes used by the profiling bucket hash table. | +| go_memstats_frees_total | | Total number of frees. | +| go_memstats_gc_sys_bytes | | Number of bytes used for garbage collection system metadata. | +| go_memstats_heap_alloc_bytes | | Number of heap bytes allocated and still in use. | +| go_memstats_heap_idle_bytes | | Number of heap bytes waiting to be used. | +| go_memstats_heap_inuse_bytes | | Number of heap bytes that are in use. | +| go_memstats_heap_objects | | Number of allocated objects. | +| go_memstats_heap_released_bytes | | Number of heap bytes released to OS. | +| go_memstats_heap_sys_bytes | | Number of heap bytes obtained from system. | +| go_memstats_last_gc_time_seconds | | Number of seconds since 1970 of last garbage collection. | +| go_memstats_lookups_total | | Total number of pointer lookups. | +| go_memstats_mallocs_total | | Total number of mallocs. | +| go_memstats_mcache_inuse_bytes | | Number of bytes in use by mcache structures. | +| go_memstats_mcache_sys_bytes | | Number of bytes used for mcache structures obtained from system. | +| go_memstats_mspan_inuse_bytes | | Number of bytes in use by mspan structures. | +| go_memstats_mspan_sys_bytes | | Number of bytes used for mspan structures obtained from system. | +| go_memstats_next_gc_bytes | | Number of heap bytes when next garbage collection will take place. | +| go_memstats_other_sys_bytes | | Number of bytes used for other system allocations. | +| go_memstats_stack_inuse_bytes | | Number of bytes in use by the stack allocator. | +| go_memstats_stack_sys_bytes | | Number of bytes obtained from system for stack allocator. | +| go_memstats_sys_bytes | | Number of bytes obtained from system. | +| go_threads | | Number of OS threads created. | +| promhttp_metric_handler_requests_in_flight | | Current number of scrapes being served. | +| promhttp_metric_handler_requests_total | `code` | Total number of scrapes by HTTP status code. |