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.

Sign up for GitHub

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

Jump to bottom

cloud: add Beta to metrics integration docs #14053

Merged
merged 6 commits into from
Jul 4, 2023
Merged

cloud: add Beta to metrics integration docs #14053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3713fd5
add beta
qqqdan Jun 29, 2023
7ea24fd
add beta info
qqqdan Jun 30, 2023
cc4a7bb
remove an extra space
qiancai Jun 30, 2023
f434b24
Apply suggestions from code review
qqqdan Jun 30, 2023
6d71dcd
change to uppercase
qqqdan Jun 30, 2023
9c1da48
Update TOC-tidb-cloud.md
qqqdan Jul 3, 2023
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 TOC-tidb-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
- [Built-in Metrics](/tidb-cloud/built-in-monitoring.md)
- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md)
- [Cluster Events](/tidb-cloud/tidb-cloud-events.md)
- [Third-Party Metrics Integrations](/tidb-cloud/third-party-monitoring-integrations.md)
- [Third-Party Metrics Integrations (Beta)](/tidb-cloud/third-party-monitoring-integrations.md)
- Tune Performance
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
- Analyze Performance
Expand Down
8 changes: 4 additions & 4 deletions tidb-cloud/monitor-datadog-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Integrate TiDB Cloud with Datadog
title: Integrate TiDB Cloud with Datadog (Beta)
summary: Learn how to monitor your TiDB cluster with the Datadog integration.
---

# Integrate TiDB Cloud with Datadog
# Integrate TiDB Cloud with Datadog (Beta)

You can configure TiDB Cloud to send metric data about your TiDB clusters to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.
TiDB Cloud supports Datadog integration (beta). You can configure TiDB Cloud to send metric data about your TiDB clusters to [Datadog](https://www.datadoghq.com/). After that, you can view these metrics in your Datadog dashboards directly.

## Prerequisites

Expand All @@ -31,7 +31,7 @@ You can configure TiDB Cloud to send metric data about your TiDB clusters to [Da
- If you have multiple projects, switch to the target project, and then click **Admin** > **Integrations**.
- If you only have one project, click **Admin** > **Integrations**.

3. Click **Integration to Datadog**.
3. Click **Integration to Datadog (BETA)**.
4. Enter your API key of Datadog and choose the site of Datadog.
5. Click **Test Integration**.

Expand Down
8 changes: 4 additions & 4 deletions tidb-cloud/monitor-new-relic-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Integrate TiDB Cloud with New Relic
title: Integrate TiDB Cloud with New Relic (Beta)
summary: Learn how to monitor your TiDB cluster with the New Relic integration.
---

# Integrate TiDB Cloud with New Relic
# Integrate TiDB Cloud with New Relic (Beta)

You can configure TiDB Cloud to send metric data of your TiDB clusters to [New Relic](https://newrelic.com/). After that, you can directly view these metrics in your New Relic dashboards.
TiDB Cloud supports New Relic integration (beta). You can configure TiDB Cloud to send metric data of your TiDB clusters to [New Relic](https://newrelic.com/). After that, you can directly view these metrics in your New Relic dashboards.

## Prerequisites

Expand All @@ -29,7 +29,7 @@ You cannot use the New Relic integration in [TiDB Serverless clusters](/tidb-clo
- If you have multiple projects, switch to the target project, and then click **Admin** > **Integrations**.
- If you only have one project, click **Admin** > **Integrations**.

3. Click **Integration to New Relic**.
3. Click **Integration to New Relic (BETA)**.
4. Enter your API key of New Relic and choose the site of New Relic.
5. Click **Test Integration**.

Expand Down
8 changes: 4 additions & 4 deletions tidb-cloud/monitor-prometheus-and-grafana-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Integrate TiDB Cloud with Prometheus and Grafana
title: Integrate TiDB Cloud with Prometheus and Grafana (Beta)
summary: Learn how to monitor your TiDB cluster with the Prometheus and Grafana integration.
---

# Integrate TiDB Cloud with Prometheus and Grafana
# Integrate TiDB Cloud with Prometheus and Grafana (Beta)

TiDB Cloud provides a [Prometheus](https://prometheus.io/) API endpoint. If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily.
TiDB Cloud provides a [Prometheus](https://prometheus.io/) API endpoint (beta). If you have a Prometheus service, you can monitor key metrics of TiDB Cloud from the endpoint easily.

This document describes how to configure your Prometheus service to read key metrics from the TiDB Cloud endpoint and how to view the metrics using [Grafana](https://grafana.com/).

Expand Down Expand Up @@ -35,7 +35,7 @@ To get the scrape_config file for Prometheus, do the following:
- If you have multiple projects, switch to the target project, and then click **Admin** > **Integrations**.
- If you only have one project, click **Admin** > **Integrations**.

3. Click **Integration to Prometheus**.
3. Click **Integration to Prometheus (BETA)**.
4. Click **Add File** to generate and show the scrape_config file for the current project.

5. Make a copy of the scrape_config file content for later use.
Expand Down
12 changes: 6 additions & 6 deletions tidb-cloud/third-party-monitoring-integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Third-Party Metrics Integrations
title: Third-Party Metrics Integrations（Beta）
summary: Learn how to use third-party metrics integrations.
---

# Third-Party Metrics Integrations
# Third-Party Metrics Integrations（Beta）

You can integrate TiDB Cloud with third-party metrics services to receive TiDB Cloud alerts and view the performance metrics of your TiDB cluster using the metrics services.
You can integrate TiDB Cloud with third-party metrics services to receive TiDB Cloud alerts and view the performance metrics of your TiDB cluster using the metrics services. The third-party metrics integrations are currently in beta.

## Required access

Expand All @@ -29,19 +29,19 @@ The available third-party integrations are displayed.

## Available integrations

### Datadog integration
### Datadog integration (beta)

With the Datadog integration, you can configure TiDB Cloud to send metric data about your TiDB clusters to [Datadog](https://www.datadoghq.com/) and view these metrics in your Datadog dashboards.

For the detailed integration steps and a list of metrics that Datadog tracks, refer to [Integrate TiDB Cloud with Datadog](/tidb-cloud/monitor-datadog-integration.md).

### Prometheus and Grafana integration
### Prometheus and Grafana integration (beta)

With the Prometheus and Grafana integration, you can get a scrape_config file for Prometheus from TiDB Cloud and use the content from the file to configure Prometheus. You can view these metrics in your Grafana dashboards.

For the detailed integration steps and a list of metrics that Prometheus tracks, see [Integrate TiDB Cloud with Prometheus and Grafana](/tidb-cloud/monitor-prometheus-and-grafana-integration.md).

### New Relic integration
### New Relic integration (beta)

With the New Relic integration, you can configure TiDB Cloud to send metric data about your TiDB clusters to [New Relic](https://newrelic.com/) and view these metrics in your New Relic dashboards.

Expand Down