Skip to content

docs(readme): mention METRICS_SOCKET_PATH env variable #656

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
icewind1991 merged 1 commit into from
Sep 29, 2025
Merged

docs(readme): mention METRICS_SOCKET_PATH env variable #656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,11 +349,14 @@ Alternatively you can set the log level of the push server in the `LOG` environm
The push server can expose some basic metrics about the number of connected clients and the traffic flowing through the
server
by setting the `METRICS_PORT` environment variable.
The metrics endpoint will listen on all interfaces by default (0.0.0.0).
However, it is also possible to bind the metrics listener to a local UNIX socket by specifying a path via the
`METRICS_SOCKET_PATH` environment variable.

Once set the metrics are available in a prometheus compatible format at `/metrics` on the configured port.
Once set the metrics are available in a prometheus compatible format at `/metrics` on the configured port or UNIX socket.

Additionally you can manually check the metrics by running the `occ notify_push:metrics` command, this will function
even if you haven't setup `METRICS_PORT`.
even if you haven't setup `METRICS_PORT` or `METRICS_SOCKET_PATH`.

### Self-signed certificates

Expand Down