Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add(valkey): metrics in prometheus #578

Merged
merged 3 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 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,53 @@
---
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 />

## Valkey-specific metrics
wojcik-dorota marked this conversation as resolved.
Show resolved Hide resolved

[Valkey-specific metrics](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/redis/README.md#metrics)
provide insights into the performance and health of your Aiven for Valkey service.
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