Skip to content

docs: Add documentation of metrics to README #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garrensmith merged 2 commits into from
Sep 21, 2023
Merged

docs: Add documentation of metrics to README #78

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fe0b28
docs: Add documentation of metrics to README
janpio Sep 20, 2023
2c6147a
Update README.md
janpio Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,19 @@ Some of the connection pool configurations can be adjusted dynamically. Each con
- max_idle_closed - The total number of connections closed due to max_idle.
- max_lifetime_closed - The total number of connections closed due to max_lifetime.

## Metrics

- Counters
- `mobc_pool_connections_opened_total` - Total number of Pool Connections opened
- `mobc_pool_connections_closed_total` - Total number of Pool Connections closed
- Gauges
- `mobc_pool_connections_open` - Number of currently open Pool Connections
- `mobc_pool_connections_busy` - Number of currently busy Pool Connections (executing a database query)"
- `mobc_pool_connections_idle` - Number of currently unused Pool Connections (waiting for the next pool query to run)
- `mobc_client_queries_wait` - Number of queries currently waiting for a connection
- Histograms
- `mobc_client_queries_wait_histogram_ms` - Histogram of the wait time of all queries in ms

## Compatibility

Because tokio is not compatible with other runtimes, such as async-std. So a database driver written with tokio cannot run in the async-std runtime. For example, you can't use redis-rs in tide because it uses tokio, so the connection pool which bases on redis-res can't be used in tide either.