You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/interfaces/prometheus.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ ClickHouse can expose its own metrics for scraping from Prometheus:
25
25
</prometheus>
26
26
27
27
Section `<prometheus.handlers>` can be used to make more extended handlers.
28
-
This section is similar to [<http_handlers>](http.md) but works for prometheus protocols:
28
+
This section is similar to [<http_handlers>](/en/interfaces/http) but works for prometheus protocols:
29
29
30
30
```xml
31
31
<prometheus>
@@ -51,11 +51,11 @@ Settings:
51
51
|---|---|---|---|
52
52
|`port`| none | Port for serving the exposing metrics protocol. |
53
53
|`endpoint`|`/metrics`| HTTP endpoint for scraping metrics by prometheus server. Starts with `/`. Should not be used with the `<handlers>` section. |
54
-
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](http.md) section. |
55
-
|`metrics`| true | Expose metrics from the [system.metrics](../operations/system-tables/metrics.md) table. |
56
-
|`asynchronous_metrics`| true | Expose current metrics values from the [system.asynchronous_metrics](../operations/system-tables/asynchronous_metrics.md) table. |
57
-
|`events`| true | Expose metrics from the [system.events](../operations/system-tables/events.md) table. |
58
-
|`errors`| true | Expose the number of errors by error codes occurred since the last server restart. This information could be obtained from the [system.errors](../operations/system-tables/errors.md) as well. |
54
+
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](/en/interfaces/http) section. |
55
+
|`metrics`| true | Expose metrics from the [system.metrics](/en/operations/system-tables/metrics) table. |
56
+
|`asynchronous_metrics`| true | Expose current metrics values from the [system.asynchronous_metrics](/en/operations/system-tables/asynchronous_metrics) table. |
57
+
|`events`| true | Expose metrics from the [system.events](/en/operations/system-tables/events) table. |
58
+
|`errors`| true | Expose the number of errors by error codes occurred since the last server restart. This information could be obtained from the [system.errors](/en/operations/system-tables/errors) as well. |
59
59
60
60
Check (replace `127.0.0.1` with the IP addr or hostname of your ClickHouse server):
61
61
```bash
@@ -65,7 +65,7 @@ curl 127.0.0.1:9363/metrics
65
65
## Remote-write protocol {#remote-write}
66
66
67
67
ClickHouse supports the [remote-write](https://prometheus.io/docs/specs/remote_write_spec/) protocol.
68
-
Data are received by this protocol and written to a [TimeSeries](../engines/table-engines/integrations/time-series.md) table
68
+
Data are received by this protocol and written to a [TimeSeries](/en/engines/table-engines/special/time_series) table
69
69
(which should be created beforehand).
70
70
71
71
```xml
@@ -89,14 +89,14 @@ Settings:
89
89
| Name | Default | Description |
90
90
|---|---|---|---|
91
91
|`port`| none | Port for serving the `remote-write` protocol. |
92
-
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](http.md) section. |
93
-
|`table`| none | The name of a [TimeSeries](../engines/table-engines/integrations/time-series.md) table to write data received by the `remote-write` protocol. This name can optionally contain the name of a database too. |
92
+
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](/en/interfaces/http) section. |
93
+
|`table`| none | The name of a [TimeSeries](/en/engines/table-engines/special/time_series) table to write data received by the `remote-write` protocol. This name can optionally contain the name of a database too. |
94
94
|`database`| none | The name of a database where the table specified in the `table` setting is located if it's not specified in the `table` setting. |
95
95
96
96
## Remote-read protocol {#remote-read}
97
97
98
98
ClickHouse supports the [remote-read](https://prometheus.io/docs/prometheus/latest/querying/remote_read_api/) protocol.
99
-
Data are read from a [TimeSeries](../engines/table-engines/integrations/time-series.md) table and sent via this protocol.
99
+
Data are read from a [TimeSeries](/en/engines/table-engines/special/time_series) table and sent via this protocol.
100
100
101
101
```xml
102
102
<prometheus>
@@ -119,8 +119,8 @@ Settings:
119
119
| Name | Default | Description |
120
120
|---|---|---|---|
121
121
|`port`| none | Port for serving the `remote-read` protocol. |
122
-
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](http.md) section. |
123
-
|`table`| none | The name of a [TimeSeries](../engines/table-engines/integrations/time-series.md) table to read data to send by the `remote-read` protocol. This name can optionally contain the name of a database too. |
122
+
|`url` / `headers` / `method`| none | Filters used to find a matching handler for a request. Similar to the fields with the same names in the [<http_handlers>](/en/interfaces/http) section. |
123
+
|`table`| none | The name of a [TimeSeries](/en/engines/table-engines/special/time_series) table to read data to send by the `remote-read` protocol. This name can optionally contain the name of a database too. |
124
124
|`database`| none | The name of a database where the table specified in the `table` setting is located if it's not specified in the `table` setting. |
125
125
126
126
## Configuration for multiple protocols {#multiple-protocols}
0 commit comments