diff --git a/docs/content/guides/operations/control-plane/observability/metrics/overview/index.md b/docs/content/guides/operations/control-plane/observability/metrics/overview/index.md new file mode 100644 index 000000000..190f25b04 --- /dev/null +++ b/docs/content/guides/operations/control-plane/observability/metrics/overview/index.md @@ -0,0 +1,14 @@ +--- +type: docs +title: "Overview: Control plane metrics" +linkTitle: "Overview" +weight: 200 +description: "Learn about Radius control plane metrics" +categories: ["Overview"] +--- + +Radius emits metrics from the control-plane which can be used for troubleshooting and monitoring. + +## Available metrics + +Refer to the [metrics reference]({{< ref "/reference/metrics" >}}) for a list of available metrics. diff --git a/docs/content/reference/metrics.md b/docs/content/reference/metrics.md new file mode 100644 index 000000000..26f5d5b0d --- /dev/null +++ b/docs/content/reference/metrics.md @@ -0,0 +1,33 @@ +--- +type: docs +title: "Reference: Available Radius metrics" +linkTitle: "Metrics" +weight: 850 +description: "Learn what metrics are available for the Radius control plane" +categories: ["Reference"] +--- + +Radius currently records following custom metrics that provide insight into its health and operations: + + * [Radius async operation metrics](#async-operation-metrics) + * [Radius recipe metrics](#recipe-metrics) + +In addition, Radius uses otelhttp meter provider. Therefore all of the HTTP metrics documented at [otelhttp metrics](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/http-metrics.md) are also available. + +## Async operation metrics + +| Metrics Name | Description | +|--------------|-------------| +|`asyncoperation.operation` | Total async operation count +|`asyncoperation.queued.operation` | Number of queued async operation +|`asyncoperation.extended.operation` | Number of extended async operation that are extended +|`asyncoperation.duration` | Async operation duration in milliseconds + +## Recipe Engine metrics + +| Metrics Name | Description | +|--------------|-------------| +| `recipe.operation.duration` | Recipe engine operation duration in milliseconds +| `recipe.download.duration` | Recipe download duration in milliseconds +| `recipe.tf.installation.duration` | Terraform installation duration in milliseconds +| `recipe.tf.init.duration` | Terraform initialization duration