Skip to content

Commit

Permalink
Update monitoring guide with couch2pg_progress_sequence metric (#1184)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkuester
jkuester committed Sep 19, 2023
1 parent df59489 commit 3ed4467
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions content/en/apps/guides/hosting/monitoring/setup.md
View file
Expand Up @@ -231,22 +231,22 @@ All the variables in the `.env` file:

All CHT metrics in Prometheus:

| OpenMetrics name | Type | label(s) | Description |
|---------------------------------------|---------|---------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cht_version` | N/A | `app`, `node`, `couchdb` | Version information for the CHT instance (recorded in labels) |
| `cht_conflict_count` | Gauge | | Number of doc conflicts which need to be resolved manually. |
| `cht_connected_users_count` | Gauge | | Number of users that have connected to the api recently. By default the time interval is 7 days. Otherwise it is equal to the connected_user_interval parameter value used when making the /monitoring request. |
| `cht_couchdb_doc_total` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of docs in the db. |
| `cht_couchdb_doc_del_total` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of deleted docs in the db. |
| `cht_couchdb_fragmentation` | Gauge | `medic`, `sentinel`, `medic-users-meta`, `_users` | The fragmentation of the db, lower is better, “1” is no fragmentation. |
| `cht_couchdb_update_sequence` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of changes in the db. |
| `cht_date_current_millis` | Counter | | The current server date in millis since the epoch, useful for ensuring the server time is correct. |
| `cht_date_uptime_seconds` | Counter | | How long API has been running. |
| `cht_feedback_total` | Counter | | Number of feedback docs created usually indicative of client side errors. |
| `cht_messaging_outgoing_last_hundred` | Gauge | `group`, `status` | Counts of last 100 messages that have received status updates. |
| `cht_messaging_outgoing_total` | Counter | `status` | Counts of the total number of messages. |
| `cht_outbound_push_backlog_count` | Gauge | | Number of changes yet to be processed by Outbound Push. |
| `cht_replication_limit_count` | Gauge | | Number of users that exceeded the replication limit of documents. |
| `cht_sentinel_backlog_count` | Gauge | | Number of changes yet to be processed by Sentinel. |
| `cht_api_*` | Any | | API server metrics (see [prometheus-api-metrics](https://www.npmjs.com/package/prometheus-api-metrics)). Requires CHT Core 4.3.0 or later. Includes stats like server response time in seconds and response size in bytes. |

| OpenMetrics name | Type | label(s) | Description |
|---------------------------------------|---------|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cht_api_*` | N/A | | API server metrics (see [prometheus-api-metrics](https://www.npmjs.com/package/prometheus-api-metrics)). Requires CHT Core 4.3.0 or later. Includes stats like server response time in seconds and response size in bytes. |
| `cht_conflict_count` | Gauge | | Number of doc conflicts which need to be resolved manually. |
| `cht_connected_users_count` | Gauge | | Number of users that have connected to the api recently. By default the time interval is 7 days. Otherwise it is equal to the connected_user_interval parameter value used when making the /monitoring request. |
| `cht_couchdb_doc_del_total` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of deleted docs in the db. |
| `cht_couchdb_doc_total` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of docs in the db. |
| `cht_couchdb_fragmentation` | Gauge | `medic`, `sentinel`, `medic-users-meta`, `_users` | The fragmentation of the db, lower is better, “1” is no fragmentation. |
| `cht_couchdb_update_sequence` | Counter | `medic`, `sentinel`, `medic-users-meta`, `_users` | The number of changes in the db. |
| `cht_date_current_millis` | Counter | | The current server date in millis since the epoch, useful for ensuring the server time is correct. |
| `cht_date_uptime_seconds` | Counter | | How long API has been running. |
| `cht_feedback_total` | Counter | | Number of feedback docs created usually indicative of client side errors. |
| `cht_messaging_outgoing_last_hundred` | Gauge | `group`, `status` | Counts of last 100 messages that have received status updates. |
| `cht_messaging_outgoing_total` | Counter | `status` | Counts of the total number of messages. |
| `cht_outbound_push_backlog_count` | Gauge | | Number of changes yet to be processed by Outbound Push. |
| `cht_replication_limit_count` | Gauge | | Number of users that exceeded the replication limit of documents. |
| `cht_sentinel_backlog_count` | Gauge | | Number of changes yet to be processed by Sentinel. |
| `cht_version` | N/A | `app`, `node`, `couchdb` | Version information for the CHT instance (recorded in labels) |
| `couch2pg_progress_sequence` | Counter | `medic`, `medic-logs`, `medic-sentinel`, `medic-users-meta`, `_users` | The number of db changes that have been processed by couch2pg. Requires [couch2pg metrics](#couch2pg-data) be enabled. |

0 comments on commit 3ed4467

Please sign in to comment.