diff --git a/docs/products/valkey/reference/valkey-metrics-in-prometheus.md b/docs/products/valkey/reference/valkey-metrics-in-prometheus.md new file mode 100644 index 000000000..f6e690717 --- /dev/null +++ b/docs/products/valkey/reference/valkey-metrics-in-prometheus.md @@ -0,0 +1,59 @@ +--- +title: Aiven for Valkey™ metrics available via Prometheus +sidebar_label: Valkey™ metrics in Prometheus +--- + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import HostMetrics from "@site/static/includes/host-metrics.md"; +import ConsoleLabel from "@site/src/components/ConsoleIcons" + +Monitor and optimize your Aiven for Valkey service with metrics available via Prometheus. +These metrics help track cluster health, replication status, and overall performance. + +## Prerequisites + +- [Enable Prometheus integration](/docs/platform/howto/integrations/prometheus-metrics). +- Note the Prometheus **username** and **password** in the **Integration endpoints** + section of the [Aiven Console](https://console.aiven.io/). + +## Access Prometheus metrics + + + + +1. Open your service's page in the + [Aiven Console](https://console.aiven.io/). +1. In the **Connection information** section, click the **Prometheus** tab. +1. Copy the **Service URI**. +1. Paste the Service URI into your browser's address bar. +1. When prompted, enter your Prometheus credentials. +1. Click **Login**. + + + + +To retrieve metrics, run the following `curl` command: + +```bash +curl --user 'USERNAME:PASSWORD' PROMETHEUS_URL/metrics +``` + +Replace `USERNAME:PASSWORD` with your Prometheus credentials and `PROMETHEUS_URL` +with the Service URI from the **Connection information** section. + + + + + + +## OpenSearch-specific metrics + +These metrics provide insights into the performance and health of your Aiven for +Valkey service. + +### Node statistics + +### Cluster statistics + +### Cluster health diff --git a/sidebars.ts b/sidebars.ts index 72d615081..2bbdfbf7a 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -1926,7 +1926,10 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'Reference', - items: ['products/valkey/reference/advanced-params'], + items: [ + 'products/valkey/reference/advanced-params', + 'products/valkey/reference/valkey-metrics-in-prometheus', + ] }, ], },