Skip to content

Commit

Permalink
Docs for new metrics (shutdown, qcmp, etc)
Browse files Browse the repository at this point in the history
Documentation for new metrics introduced in googleforgames#1047
  • Loading branch information
markmandel committed Dec 11, 2024
1 parent e2019ba commit 17da89e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/src/deployment/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,11 @@ Quilkin exposes the following metrics on heap allocations, which are useful for

* `quilkin_extant_allocation_count` (Gauge)

The current number of extant allocations"
The current number of extant allocations

* `quilkin_shutdown_initiated`

Shutdown process has been started

### /debug/pprof/profile

Expand Down
10 changes: 9 additions & 1 deletion docs/src/services/proxy/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The proxy exposes the following general metrics:

* `quilkin_bytes_total{event, asn, ip_prefix}`

The total number of bytes sent or recieved
The total number of bytes sent or received
* The `event` label is either:
* `read`: when the proxy receives data from a downstream connection on the listening port.
* `write`: when the proxy sends data to a downstream connection via the listening port.
Expand All @@ -69,6 +69,14 @@ The proxy exposes the following general metrics:

The total number of errors encountered while reading a packet from the upstream endpoint.

* `quilkin_game_traffic_tasks`

The amount of game traffic tasks that have spawned

* `quilkin_game_traffic_task_closed`

The amount of game traffic tasks that have shutdown

## Session Metrics

The proxy exposes the following metrics around sessions:
Expand Down
14 changes: 14 additions & 0 deletions docs/src/services/proxy/qcmp.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,17 @@ request to the QCMP port.

The returned data is a JSON object with each key being the ICAO code for the
datacentre, and the value being the latency in nanoseconds.

## Metrics

* `quilkin_phoenix_requests`

The amount of phoenix (latency) requests

* `quilkin_phoenix_task_closed`

Whether the phoenix latency measurement task has shutdown

* `quilkin_phoenix_server_errors`

The amount of errors attempting to spawn the phoenix HTTP server

0 comments on commit 17da89e

Please sign in to comment.