Skip to content

Commit

Permalink
valkey metrics in prometheus
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik-dorota committed Nov 26, 2024
1 parent b8d18d4 commit 7f68485
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 1 deletion.
59 changes: 59 additions & 0 deletions docs/products/valkey/reference/valkey-metrics-in-prometheus.md
Original file line number Diff line number Diff line change
@@ -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

<Tabs groupId="group1">
<TabItem value="browser" label="Browser" default>

1. Open your service's <ConsoleLabel name="overview"/> 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**.

</TabItem>
<TabItem value="cli" label="CLI">

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.

</TabItem>
</Tabs>

<HostMetrics />

## OpenSearch-specific metrics

These metrics provide insights into the performance and health of your Aiven for
Valkey service.

### Node statistics

### Cluster statistics

### Cluster health
5 changes: 4 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
]
},
],
},
Expand Down

0 comments on commit 7f68485

Please sign in to comment.