Add prometheus metrics lists to docs (pipe-cd#4533)

* Add prometheus metrics lists to docs Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add missing metrics Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Move metric docs to under user guide Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> --------- Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> Signed-off-by: sZma5a <masaaki.haribote@gmail.com>
sZma5a · Aug 27, 2023 · 115d111 · 115d111
1 parent 7173b39
commit 115d111
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 10 deletions.
diff --git a/docs/content/en/docs-dev/user-guide/command-line-tool.md b/docs/content/en/docs-dev/user-guide/command-line-tool.md
@@ -1,7 +1,7 @@
 ---
 title: "Command-line tool: pipectl"
 linkTitle: "Command-line tool: pipectl"
-weight: 8
+weight: 9
 description: >
   This page describes how to install and use pipectl to manage PipeCD's resources.
 ---

diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md
@@ -1,7 +1,7 @@
 ---
 title: "Configuration reference"
 linkTitle: "Configuration reference"
-weight: 10
+weight: 11
 description: >
   This page describes all configurable fields in the application configuration and analysis template.
 ---

diff --git a/docs/content/en/docs-dev/user-guide/examples/_index.md b/docs/content/en/docs-dev/user-guide/examples/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "Examples"
 linkTitle: "Examples"
-weight: 11
+weight: 12
 description: >
   Some examples of PipeCD in action!
 ---

diff --git a/...er-guide/managing-controlplane/metrics.md → ...content/en/docs-dev/user-guide/metrics.md b/...er-guide/managing-controlplane/metrics.md → ...content/en/docs-dev/user-guide/metrics.md
@@ -1,7 +1,7 @@
 ---
 title: "Metrics"
 linkTitle: "Metrics"
-weight: 5
+weight: 8
 description: >
   This page describes how to enable monitoring system for collecting PipeCD' metrics.
 ---
@@ -86,3 +86,27 @@ And give it to the `helm install` command when [installing](../../../installatio
 ```
 
 See [here](https://prometheus.io/docs/alerting/latest/configuration/) for more details on AlertManager's configuration.
+
+## Piped agent metrics
+
+| Metric | Type | Description |
+| --- | --- | --- |
+| `cloudprovider_kubernetes_tool_calls_total` | counter | Number of calls made to run the tool like kubectl, kustomize. |
+| `deployment_status` | gauge | The current status of deployment. 1 for current status, 0 for others. |
+| `livestatestore_kubernetes_api_requests_total` | counter | Number of requests sent to kubernetes api server. |
+| `livestatestore_kubernetes_resource_events_total` | counter | Number of resource events received from kubernetes server. |
+| `plan_preview_command_handled_total` | counter | Total number of plan-preview commands handled at piped. |
+| `plan_preview_command_handling_seconds` | histogram | Histogram of handling seconds of plan-preview commands. |
+| `plan_preview_command_received_total` | counter | Total number of plan-preview commands received at piped. |
+
+## Control plane metrics
+
+All Piped's metrics are sent to the control plane so that they are also available on the control plane's metrics server.
+
+| Metric | Type | Description |
+| --- | --- | --- |
+| `cache_get_operation_total` | counter | Number of cache get operation while processing. |
+| `grpcapi_create_deployment_total` | counter | Number of successful CreateDeployment RPC with project label. |
+| `http_request_duration_milliseconds` | histogram | Histogram of request latencies in milliseconds. |
+| `http_requests_total` | counter | Total number of HTTP requests. |
+| `insight_application_total` | gauge | Number of applications currently controlled by control plane. |
diff --git a/docs/content/en/docs-dev/user-guide/terraform-provider-pipecd.md b/docs/content/en/docs-dev/user-guide/terraform-provider-pipecd.md
@@ -1,7 +1,7 @@
 ---
 title: "PipeCD Terraform provider"
 linkTitle: "PipeCD Terraform provider"
-weight: 9
+weight: 10
 description: >
   This page describes how to manage PipeCD resources with Terraform using terraform-provider-pipecd.
 ---

diff --git a/docs/content/en/docs-v0.44.x/user-guide/command-line-tool.md b/docs/content/en/docs-v0.44.x/user-guide/command-line-tool.md
@@ -1,7 +1,7 @@
 ---
 title: "Command-line tool: pipectl"
 linkTitle: "Command-line tool: pipectl"
-weight: 8
+weight: 9
 description: >
   This page describes how to install and use pipectl to manage PipeCD's resources.
 ---

diff --git a/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.44.x/user-guide/configuration-reference.md
@@ -1,7 +1,7 @@
 ---
 title: "Configuration reference"
 linkTitle: "Configuration reference"
-weight: 10
+weight: 11
 description: >
   This page describes all configurable fields in the application configuration and analysis template.
 ---

diff --git a/docs/content/en/docs-v0.44.x/user-guide/examples/_index.md b/docs/content/en/docs-v0.44.x/user-guide/examples/_index.md
@@ -1,7 +1,7 @@
 ---
 title: "Examples"
 linkTitle: "Examples"
-weight: 11
+weight: 12
 description: >
   Some examples of PipeCD in action!
 ---

diff --git a/...er-guide/managing-controlplane/metrics.md → ...ent/en/docs-v0.44.x/user-guide/metrics.md b/...er-guide/managing-controlplane/metrics.md → ...ent/en/docs-v0.44.x/user-guide/metrics.md
@@ -1,7 +1,7 @@
 ---
 title: "Metrics"
 linkTitle: "Metrics"
-weight: 5
+weight: 8
 description: >
   This page describes how to enable monitoring system for collecting PipeCD' metrics.
 ---
@@ -86,3 +86,27 @@ And give it to the `helm install` command when [installing](../../../installatio
 ```
 
 See [here](https://prometheus.io/docs/alerting/latest/configuration/) for more details on AlertManager's configuration.
+
+## Piped agent metrics
+
+| Metric | Type | Description |
+| --- | --- | --- |
+| `cloudprovider_kubernetes_tool_calls_total` | counter | Number of calls made to run the tool like kubectl, kustomize. |
+| `deployment_status` | gauge | The current status of deployment. 1 for current status, 0 for others. |
+| `livestatestore_kubernetes_api_requests_total` | counter | Number of requests sent to kubernetes api server. |
+| `livestatestore_kubernetes_resource_events_total` | counter | Number of resource events received from kubernetes server. |
+| `plan_preview_command_handled_total` | counter | Total number of plan-preview commands handled at piped. |
+| `plan_preview_command_handling_seconds` | histogram | Histogram of handling seconds of plan-preview commands. |
+| `plan_preview_command_received_total` | counter | Total number of plan-preview commands received at piped. |
+
+## Control plane metrics
+
+All Piped's metrics are sent to the control plane so that they are also available on the control plane's metrics server.
+
+| Metric | Type | Description |
+| --- | --- | --- |
+| `cache_get_operation_total` | counter | Number of cache get operation while processing. |
+| `grpcapi_create_deployment_total` | counter | Number of successful CreateDeployment RPC with project label. |
+| `http_request_duration_milliseconds` | histogram | Histogram of request latencies in milliseconds. |
+| `http_requests_total` | counter | Total number of HTTP requests. |
+| `insight_application_total` | gauge | Number of applications currently controlled by control plane. |
diff --git a/docs/content/en/docs-v0.44.x/user-guide/terraform-provider-pipecd.md b/docs/content/en/docs-v0.44.x/user-guide/terraform-provider-pipecd.md
@@ -1,7 +1,7 @@
 ---
 title: "PipeCD Terraform provider"
 linkTitle: "PipeCD Terraform provider"
-weight: 9
+weight: 10
 description: >
   This page describes how to manage PipeCD resources with Terraform using terraform-provider-pipecd.
 ---