Add description for Kubernetes client metrics (googleforgames#1409)

Fix sdkServer logLevel parameter name in reference Co-authored-by: Mark Mandel <markmandel@google.com>
ilkercelikyilmaz · Oct 23, 2020 · 701f09b · 701f09b
1 parent c2fb48f
commit 701f09b
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/site/content/en/docs/Guides/metrics.md b/site/content/en/docs/Guides/metrics.md
@@ -49,9 +49,8 @@ Follow the [Stackdriver Installation steps](#stackdriver-installation) to see yo
 | Name                                            | Description                                                         | Type      |
 |-------------------------------------------------|---------------------------------------------------------------------|-----------|
 | agones_gameservers_count                        | The number of gameservers per fleet and status                      | gauge     |
-| agones_fleet_allocations_count                  | The number of fleet allocations per fleet                           | 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_fleet_allocations_total                  | The total of fleet allocations per fleet                            | counter   |
 | agones_fleets_replicas_count                    | The number of replicas per fleet (total, desired, ready, 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     |
@@ -61,6 +60,20 @@ Follow the [Stackdriver Installation steps](#stackdriver-installation) to see yo
 | 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_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   |
 
 ## Dashboard
 
@@ -70,10 +83,12 @@ We provide a set of useful [Grafana](https://grafana.com/) dashboards to monitor
 
 - {{< ghlink href="/build/grafana/dashboard-autoscalers.yaml" branch="master" >}}Agones Autoscalers{{< /ghlink >}} allows you to monitor your current autoscalers replicas request as well as fleet replicas allocation and readyness statuses. You can only select one autoscaler at the time using the provided dropdown.
 
-- {{< ghlink href="/build/grafana/dashboard-gameservers.yaml" branch="master" >}}Agones GameServers{{< /ghlink >}} displays your current game servers workload status (allocations , game servers statuses, fleets replicas) with optional fleet name filtering.
+- {{< ghlink href="/build/grafana/dashboard-gameservers.yaml" branch="master" >}}Agones GameServers{{< /ghlink >}} displays your current game servers workload status (allocations, game servers statuses, fleets replicas) with optional fleet name filtering.
 
 - {{< ghlink href="/build/grafana/dashboard-allocations.yaml" branch="master" >}}Agones GameServer Allocations{{< /ghlink >}} displays Agones gameservers allocations rates and counts per fleet.
 
+- {{< ghlink href="/build/grafana/dashboard-allocator-usage.yaml" branch="master" >}}Agones Allocator Resource{{< /ghlink >}} displays Agones Allocators CPU, memory usage and also some useful Golang runtime metrics.
+
 - {{< ghlink href="/build/grafana/dashboard-status.yaml" branch="master" >}}Agones Status{{< /ghlink >}} displays Agones controller health status.
 
 - {{< ghlink href="/build/grafana/dashboard-controller-usage.yaml" branch="master" >}}Agones Controller Resource Usage{{< /ghlink >}} displays Agones Controller CPU and memory usage and also some Golang runtime metrics.

diff --git a/site/content/en/docs/Reference/gameserver.md b/site/content/en/docs/Reference/gameserver.md
@@ -98,7 +98,7 @@ The `spec` field is the actual GameServer specification and it is composed as fo
   - `protocol` the protocol being used. Defaults to UDP. TCP is the only other option.
 - `health` to track the overall healthy state of the GameServer, more information available in the [health check documentation]({{< relref "../Guides/health-checking.md" >}}).
 -`sdkServer` defines parameters for the game server sidecar
-  - `logging` field defines log level for SDK server. Defaults to "Info". It has three options:
+  - `logLevel` field defines log level for SDK server. Defaults to "Info". It has three options:
     - "Info" (default) The SDK server will output all messages except for debug messages
     - "Debug" The SDK server will output all messages including debug messages
     - "Error" The SDK server will only output error messages