Skip to content

Commit 7fbb8ea

Browse files
committed
Add docs for fluss-metrics-opentelemetry
1 parent 0556fc2 commit 7fbb8ea

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

website/docs/maintenance/observability/metric-reporters.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ reporters will be instantiated on each CoordinatorServer and TabletServers when
1212
Example reporter configuration that specifies multiple reporters:
1313

1414
```yaml
15-
metrics.reporters: jmx,prometheus
15+
metrics.reporters: jmx,opentelemetry
1616
```
1717
1818
## Push vs. Pull
@@ -57,6 +57,34 @@ An example for such a list would be `cluster_id=fluss1,host=localhost,server_id=
5757

5858
The domain thus identifies a metric class, while the key-property list identifies one (or multiple) instances of that metric.
5959

60+
### OpenTelemetry
61+
62+
Type: push
63+
64+
Parameters:
65+
66+
- `metrics.reporter.opentelemetry.endpoint` - Target to which the OpenTelemetry metric reporter is going to send metrics to.
67+
- `metrics.reporter.opentelemetry.exporter` - The type of exporter that is used by the OpenTelemetry metric exporter to send metrics to the configured endpoint. The endpoint must accept connections for the given exporter type. Supported exporters: GRPC, HTTP.
68+
- `metrics.reporter.opentelemetry.export-interval` - (optional) Frequency of metric export by the OpenTelemetry metric reporter to the endpoint. Default: 10s.
69+
- `metrics.reporter.opentelemetry.export-timeout` - (optional) Maximum time the OpenTelemetry metric reporter will wait for each metric export. Default: 10s.
70+
71+
Example configuration:
72+
73+
```yaml
74+
metrics.reporters: opentelemetry
75+
metrics.reporter.opentelemetry.exporter: GRPC
76+
metrics.reporter.opentelemetry.endpoint: http://opentelemetry-collector:4317
77+
```
78+
79+
Fluss metric types are mapped to OpenTelemetry metric types as follows:
80+
81+
| Fluss | OpenTelemetry | Note |
82+
|-----------|-------------------------|---------------------------------------------------------------|
83+
| Counter | LONG_SUM | |
84+
| Gauge | LONG_GAUGE/DOUBLE_GAUGE | Automatically determined by the type of the Gauge. |
85+
| Histogram | SUMMARY | Quantiles .5, .75, .95, .99 |
86+
| Meter | LONG_SUM, DOUBLE_GAUGE | Exports the meter's count (LONG_SUM) and rate (DOUBLE_GAUGE). |
87+
6088
### Prometheus
6189

6290
Type: pull
@@ -74,9 +102,9 @@ metrics.reporter.prometheus.port: 9250
74102

75103
Fluss metric types are mapped to Prometheus metric types as follows:
76104

77-
| Fluss | Prometheus | Note |
78-
| --------- |------------|------------------------------------------|
79-
| Counter | Gauge |Prometheus counters cannot be decremented.|
80-
| Gauge | Gauge |Only numbers and booleans are supported. |
81-
| Histogram | Summary |Quantiles .5, .75, .95, .98, .99 and .999 |
82-
| Meter | Gauge |The gauge exports the meter's rate. |
105+
| Fluss | Prometheus | Note |
106+
|-----------|------------|--------------------------------------------|
107+
| Counter | Gauge | Prometheus counters cannot be decremented. |
108+
| Gauge | Gauge | Only numbers and booleans are supported. |
109+
| Histogram | Summary | Quantiles .5, .75, .95, .98, .99 and .999 |
110+
| Meter | Gauge | The gauge exports the meter's rate. |

0 commit comments

Comments
 (0)