Skip to content

Commit 6728e08

Browse files
Copilotfengjiachun
andcommitted
Remove export_metrics configuration from main docs
Co-authored-by: fengjiachun <[email protected]>
1 parent 88086b4 commit 6728e08

File tree

2 files changed

+1
-99
lines changed

2 files changed

+1
-99
lines changed

docs/user-guide/deployments-administration/configuration.md

Lines changed: 0 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -508,59 +508,6 @@ The `meta_client` configures the Metasrv client, including:
508508
- `ddl_timeout`, DDL execution timeout, `10s` by default.
509509
- `tcp_nodelay`, `TCP_NODELAY` option for accepted connections, true by default.
510510

511-
### Monitor metrics options
512-
513-
These options are used to save system metrics to GreptimeDB itself.
514-
For instructions on how to use this feature, please refer to the [Monitoring](/user-guide/deployments-administration/monitoring/overview.md) guide.
515-
516-
```toml
517-
[export_metrics]
518-
# Whether to enable export_metrics
519-
enable=true
520-
# Export time interval
521-
write_interval = "30s"
522-
```
523-
524-
- `enable`: Whether to enable export_metrics, `false` by default.
525-
- `write_interval`: Export time interval.
526-
527-
#### `self_import` method
528-
529-
If you are using `standalone`, you can use the `self_import` method to export metrics to GreptimeDB itself.
530-
531-
```toml
532-
[export_metrics]
533-
# Whether to enable export_metrics
534-
enable=true
535-
# Export time interval
536-
write_interval = "30s"
537-
[export_metrics.self_import]
538-
db = "information_schema"
539-
```
540-
541-
- `db`: The default database used by `self_import` is `information_schema`. You can also create another database for saving system metrics.
542-
543-
#### `remote_write` method
544-
545-
The `remote_write` method is supported by `datanode`, `frontend`, `metasrv`, and `standalone`.
546-
It sends metrics to a receiver compatible with the [Prometheus Remote-Write protocol](https://prometheus.io/docs/concepts/remote_write_spec/).
547-
548-
```toml
549-
[export_metrics]
550-
# Whether to enable export_metrics
551-
enable=true
552-
# Export time interval
553-
write_interval = "30s"
554-
[export_metrics.remote_write]
555-
# URL specified by Prometheus Remote-Write protocol
556-
url = "http://127.0.0.1:4000/v1/prometheus/write?db=information_schema"
557-
# Some optional HTTP parameters, such as authentication information
558-
headers = { Authorization = "Basic Z3JlcHRpbWVfdXNlcjpncmVwdGltZV9wd2Q=" }
559-
```
560-
561-
- `url`: URL specified by Prometheus Remote-Write protocol.
562-
- `headers`: Some optional HTTP parameters, such as authentication information.
563-
564511
### Heartbeat configuration
565512
Heartbeat configuration is available in `frontend` and `datanode`.
566513
```toml

docs/user-guide/deployments-administration/monitoring/standalone-monitoring.md

Lines changed: 1 addition & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,7 @@ description: Guide to monitor GreptimeDB standalone instance using Prometheus me
77

88
GreptimeDB standalone provides a `/metrics` endpoint on the HTTP port (default `4000`) that exposes [Prometheus metrics](/reference/http-endpoints.md#metrics).
99

10-
## Monitoring configuration
11-
12-
You can configure GreptimeDB to export metrics to GreptimeDB itself or to an external Prometheus instance.
13-
14-
### Internal Metrics Storage
15-
16-
Configuring GreptimeDB to store its own metrics internally is convenient and recommended for self-monitoring,
17-
it also enables SQL-based querying and analysis.
18-
19-
To enable self-monitoring, configure the `export_metrics` section in your TOML configuration file:
20-
21-
```toml
22-
[export_metrics]
23-
enable = true
24-
# Metrics collection interval
25-
write_interval = "30s"
26-
[export_metrics.self_import]
27-
db = "greptime_metrics"
28-
```
29-
30-
This configuration:
31-
- Collects and writes metrics every 30 seconds.
32-
- Exports metrics to the `greptime_metrics` database within GreptimeDB. Ensure the `greptime_metrics` database [is created](/reference/sql/create.md#create-database) before exporting metrics.
33-
34-
### Export metrics to Prometheus
35-
36-
For environments with existing Prometheus infrastructure,
37-
GreptimeDB can export metrics via the Prometheus remote write protocol.
38-
39-
To do this, configure the `export_metrics` section in your TOML configuration file with the `remote_write` option:
40-
41-
```toml
42-
[export_metrics]
43-
enable=true
44-
write_interval = "30s"
45-
[export_metrics.remote_write]
46-
# URL specified by Prometheus Remote-Write protocol
47-
url = "https://your/remote_write/endpoint"
48-
# Some optional HTTP parameters, such as authentication information
49-
headers = { Authorization = {{Authorization}} }
50-
```
51-
52-
This configuration:
53-
- Sets the export interval to 30 seconds
54-
- Specifies the Prometheus remote write URL, which should point to your Prometheus instance
55-
- Optionally includes HTTP headers for the remote write URL, such as authentication information
10+
You can use Prometheus to scrape these metrics and Grafana to visualize them.
5611

5712
## Grafana Dashboard Integration
5813

0 commit comments

Comments
 (0)