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

docs: moved metrics content to monitor #11101

Merged
merged 3 commits into from
Apr 18, 2023
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
2 changes: 1 addition & 1 deletion docs/doc/10-deploy/06-metasrv/60-metasrv-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Returns the status information of each meta node in the cluster.

## Meta Metrics API

Shows a bunch of metrics that Databend captures and tracks about the meta service performance. For more information about the meta service metrics, see [Databend Meta Metrics](50-metasrv-metrics.md).
Shows a bunch of metrics that Databend captures and tracks about the meta service performance. For more information about the meta service metrics, see [Databend Meta Metrics](../../13-monitor/10-metasrv-metrics.md).

### Request Endpoint

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Databend Meta Metrics
sidebar_label: Meta Service Metrics
sidebar_label: Meta Metrics
description:
Databend Meta Service Metrics
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Databend Query Metrics
sidebar_label: Databend Query Metrics
sidebar_label: Query Metrics
description:
Databend Query Metrics
---

A `databend-query` server records metrics in table [system.metrics](../../13-sql-reference/20-system-tables/system-metrics.md).
A `databend-query` server records metrics in table [system.metrics](../13-sql-reference/20-system-tables/system-metrics.md).

The [metric_api_address](../07-query/10-query-config.md) to listen on that can be scraped by Prometheus and will return a [prometheus](http://prometheus.io/docs/instrumenting/exposition_formats/) format of metrics.
The [metric_api_address](../10-deploy/07-query/10-query-config.md) to listen on that can be scraped by Prometheus and will return a [prometheus](http://prometheus.io/docs/instrumenting/exposition_formats/) format of metrics.

> Note: Default metric_api_address value is : 127.0.0.1:7070 , Prometheus can access this uri: http://127.0.0.1:7070/metrics

Expand Down
3 changes: 3 additions & 0 deletions docs/doc/13-monitor/tools/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Using 3rd-Party Tools"
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The steps below describe how to install and deploy Prometheus using Docker.

Check the value on the right of each instance. `1` means the instance is healthy, and `0` means that the scrape failed.

![Prometheus up](../../public/img/tracing/prometheus-up.png)
![Prometheus up](../../../public/img/tracing/prometheus-up.png)

### Step 3. Deploy Grafana

Expand All @@ -102,12 +102,12 @@ The steps below describe how to install and deploy Grafana using Docker.

Please note that set the URL to `http://host.docker.internal:9090` for the data source.

![Grafana data source](../../public/img/tracing/grafana-datasource.png)
![Grafana data source](../../../public/img/tracing/grafana-datasource.png)

4. Create dashboards.

Databend recommend import the files in [datafuselabs/helm-charts - dashboards](https://github.com/datafuselabs/helm-charts/tree/main/dashboards) to create your dashboards. To do so, download the files first, then go to `http://0.0.0.0:3000/dashboard/import` to import the downloaded files one by one and select the `Prometheus` data source for each dashboard.

![Grafana import query json](../../public/img/tracing/grafana-query-json.png)
![Grafana import query json](../../../public/img/tracing/grafana-query-json.png)

![Grafana query dashboard](../../public/img/tracing/grafana-query-dashboard.png)
![Grafana query dashboard](../../../public/img/tracing/grafana-query-dashboard.png)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This tutorial uses the Sentry service on the cloud. To sign up an account for Cl

Once you're logged into Sentry, create a Sentry project for the `Rust` platform to start. For how to create a project on Sentry, see https://docs.sentry.io/product/sentry-basics/integrate-frontend/create-new-project/

![Alt text](../../public/img/tracing/sentry-rust.png)
![Alt text](../../../public/img/tracing/sentry-rust.png)

### Step 3. Set Environment Variables

Expand Down Expand Up @@ -48,4 +48,4 @@ Follow the [Deployment Guide](https://databend.rs/doc/deploy) to deploy Databend

You're all set now. Check the pages on Sentry for alerts and performance information.

![Alt text](../../public/img/tracing/sentry-done.png)
![Alt text](../../../public/img/tracing/sentry-done.png)