Skip to content

docs: add coroot integration #1982

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
35 changes: 35 additions & 0 deletions docs/user-guide/integrations/coroot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
keywords: [Coroot, APM, Observability, Prometheus, integration]
description: Integrate GreptimeDB with Coroot.
---

# Coroot

Coroot is an open-source APM & Observability tool,
a DataDog and NewRelic alternative. Metrics, logs, traces, continuous profiling,
and SLO-based alerting, supercharged with predefined dashboards and inspections.

GreptimeDB can be configured as a Prometheus data sink for Coroot.
To integrate GreptimeDB with Coroot, navigate to `Settings` in the Coroot Dashboard,
select the `Prometheus` configuration, and enter the following information:

- Prometheus URL: `http{s}://<GreptimeDB_host>/v1/prometheus`
- If you have [enabled authentication](/user-guide/deployments-administration/authentication/static.md) on GreptimeDB, check the HTTP basic auth option and enter GreptimeDB username and password. Otherwise, leave it unchecked.
- Remote Write URL: `http{s}://<GreptimeDB_host>/v1/prometheus/write?db=<db-name>`

## Example Configuration

If your GreptimeDB host is `localhost` with port `4000` for the HTTP service and authentication is enabled,
and you want to use the default database `public`,
use the following configuration:

- Prometheus URL: `http://localhost:4000/v1/prometheus`
- Enable the HTTP basic auth option and enter GreptimeDB username and password
- Remote Write URL: `http://localhost:4000/v1/prometheus/write?db=public`

The image below shows the Coroot configuration example:

<p align="center">
<img src="/coroot.jpg" alt="Coroot Configuration Example" width="600"/>
</p>

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
keywords: [Coroot, APM, Observability, Prometheus, integration]
description: 将 GreptimeDB 与 Coroot 集成。
---

# Coroot

Coroot 是一个开源的 APM 和可观测性工具,
是 DataDog 和 NewRelic 的替代方案。
预定义的仪表板具备指标、日志、链路追踪、持续性能分析
和基于 SLO 的告警功能。

GreptimeDB 可以配置为 Coroot 中的 Prometheus 数据存储。
要将 GreptimeDB 集成到 Coroot 中,
需要在 Coroot 仪表板中导航到 `Settings`,
选择 `Prometheus` 配置,然后输入以下信息:

- Prometheus URL: `http{s}://<GreptimeDB_host>/v1/prometheus`
- 如果你在 GreptimeDB 上[启用了身份验证](/user-guide/deployments-administration/authentication/static.md),请勾选 HTTP basic auth 并输入 GreptimeDB 用户名和密码。如果没有启用身份认证,保留未勾选状态即可。
- Remote Write URL: `http{s}://<GreptimeDB_host>/v1/prometheus/write?db=<db-name>`

## 示例配置

如果你的 GreptimeDB 被部署在 `localhost`,HTTP 服务端口为 `4000`,已启用身份验证,
并且使用默认数据库 `public`,
请使用以下配置:

- Prometheus URL: `http://localhost:4000/v1/prometheus`
- 启用 HTTP basic auth 选项并输入 GreptimeDB 用户名和密码
- Remote Write URL: `http://localhost:4000/v1/prometheus/write?db=public`

下图是 Coroot 的配置示例:

<p align="center">
<img src="/coroot.jpg" alt="Coroot 配置示例" width="600"/>
</p>
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ const sidebars: SidebarsConfig = {
'user-guide/integrations/streamlit',
'user-guide/integrations/mindsdb',
'user-guide/integrations/fluent-bit',
'user-guide/integrations/coroot',
],
},
{
Expand Down
Binary file added static/coroot.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.