Skip to content
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.

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

Add documentation for metrics available #1213

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ThisIsMissEm
Copy link
Contributor

I noticed we didn't yet have documentation on the various metrics that Mastodon produces, so I've started to document them; This will likely need a bunch of work to be comprehensive and really useful.

@vercel
Copy link

vercel bot commented May 6, 2023

@ThisIsMissEm is attempting to deploy a commit to the Mastodon Team on Vercel.

A member of the Team first needs to authorize it.

| Gauge | pg_pool_waiting_queries | The number of queued requests waiting on a postgresql client when all clients are checked out |
| Gauge | connected_clients | The number of clients connected to the streaming server, these are labelled with the type of connection: `http` or `websocket` |
| Gauge | connected_channels | The number of Redis channels the streaming server is subscribed to |
| Histogram | streaming_latency | The time delta between when an event is published to redis from Ruby and when the streaming server processes that event |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this is a new metric (see: mastodon/mastodon#24886 )

| Gauge | pg_pool_total_connections | The total number of clients existing within the postgresql pool |
| Gauge | pg_pool_idle_connections | The number of clients which are not checked out but are currently idle in the postgresql pool |
| Gauge | pg_pool_waiting_queries | The number of queued requests waiting on a postgresql client when all clients are checked out |
| Gauge | connected_clients | The number of clients connected to the streaming server, these are labelled with the type of connection: `http` or `websocket` |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: The labelling is added in: mastodon/mastodon#24886

@trwnh
Copy link
Member

trwnh commented May 7, 2023

if feasible, i think it would be better to express this information using definition lists instead of using tables. tables don't reflow well for mobile viewers

@ThisIsMissEm
Copy link
Contributor Author

if feasible, i think it would be better to express this information using definition lists instead of using tables. tables don't reflow well for mobile viewers

I originally had this as lists with everything inline, but a table seemed nicer formatting. Not sure if it's possible to do definition lists (I've never tried that in markdown)

@trwnh
Copy link
Member

trwnh commented May 7, 2023

it's something like this

term
: definition

you might also use subheaders to categorize certain things or allow for a certain page outline

@ThisIsMissEm ThisIsMissEm mentioned this pull request May 17, 2024
79 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants