-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8d18d4
commit 7f68485
Showing
2 changed files
with
63 additions
and
1 deletion.
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
docs/products/valkey/reference/valkey-metrics-in-prometheus.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters