Skip to content

Commit

Permalink
Add docs for reserved replicas metric
Browse files Browse the repository at this point in the history 
Noticed there weren't docs for googleforgames#2609, so here there are!
  • Loading branch information
@markmandel
markmandel committed Jun 6, 2022
1 parent fd64401 commit 0a3f465
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions site/content/en/docs/Guides/metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,42 @@ Follow the [Stackdriver Installation steps](#stackdriver-installation) to see yo
## Metrics available
{{% feature publishVersion="1.24.0" %}}
| Name | Description | Type |
|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
| agones_gameservers_count | The number of gameservers per fleet and status | gauge |
| agones_gameserver_allocations_duration_seconds | The distribution of gameserver allocation requests latencies | histogram |
| agones_gameservers_total | The total of gameservers per fleet and status | counter |
| agones_fleets_replicas_count | The number of replicas per fleet (total, desired, ready, reserved, allocated) | gauge |
| agones_fleet_autoscalers_able_to_scale | The fleet autoscaler can access the fleet to scale | gauge |
| agones_fleet_autoscalers_buffer_limits | The limits of buffer based fleet autoscalers (min, max) | gauge |
| agones_fleet_autoscalers_buffer_size | The buffer size of fleet autoscalers (count or percentage) | gauge |
| agones_fleet_autoscalers_current_replicas_count | The current replicas count as seen by autoscalers | gauge |
| agones_fleet_autoscalers_desired_replicas_count | The desired replicas count as seen by autoscalers | gauge |
| agones_fleet_autoscalers_limited | The fleet autoscaler is capped (1) | gauge |
| agones_gameservers_node_count | The distribution of gameservers per node | histogram |
| agones_nodes_count | The count of nodes empty and with gameservers | gauge |
| agones_gameservers_state_duration | The distribution of gameserver state duration in seconds. Note: this metric could have some missing samples by design. Do not use the `_total` counter as the real value for state changes. | histogram |
| agones_k8s_client_http_request_total | The total of HTTP requests to the Kubernetes API by status code | counter |
| agones_k8s_client_http_request_duration_seconds | The distribution of HTTP requests latencies to the Kubernetes API by status code | histogram |
| agones_k8s_client_cache_list_total | The total number of list operations for client-go caches | counter |
| agones_k8s_client_cache_list_duration_seconds | Duration of a Kubernetes list API call in seconds | histogram |
| agones_k8s_client_cache_list_items | Count of items in a list from the Kubernetes API | histogram |
| agones_k8s_client_cache_watches_total | The total number of watch operations for client-go caches | counter |
| agones_k8s_client_cache_last_resource_version | Last resource version from the Kubernetes API | gauge |
| agones_k8s_client_workqueue_depth | Current depth of the work queue | gauge |
| agones_k8s_client_workqueue_latency_seconds | How long an item stays in the work queue | histogram |
| agones_k8s_client_workqueue_items_total | Total number of items added to the work queue | counter |
| agones_k8s_client_workqueue_work_duration_seconds | How long processing an item from the work queue takes | histogram |
| agones_k8s_client_workqueue_retries_total | Total number of items retried to the work queue | counter |
| agones_k8s_client_workqueue_longest_running_processor | How long the longest running workqueue processor has been running in microseconds | gauge |
| agones_k8s_client_workqueue_unfinished_work_seconds | How long unfinished work has been sitting in the workqueue in seconds | gauge |

{{% /feature %}}

{{% feature expiryVersion="1.24.0" %}}

| Name | Description | Type |
|-------------------------------------------------|---------------------------------------------------------------------|-----------|
| agones_gameservers_count | The number of gameservers per fleet and status | gauge |
Expand Down Expand Up @@ -66,6 +102,8 @@ Follow the [Stackdriver Installation steps](#stackdriver-installation) to see yo
| agones_k8s_client_workqueue_longest_running_processor | How long the longest running workqueue processor has been running in microseconds | gauge |
| agones_k8s_client_workqueue_unfinished_work_seconds | How long unfinished work has been sitting in the workqueue in seconds | gauge |

{{% /feature %}}

## Dashboard

### Grafana Dashboards
Expand Down

0 comments on commit 0a3f465

Please sign in to comment.