Skip to content
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
Binary file modified website/docs/assets/fluss-quickstart-observability.zip
Binary file not shown.
9 changes: 4 additions & 5 deletions website/docs/install-deploy/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ We have listed them in the table below the figure.
<td>
<li>[JMX](maintenance/observability/metric-reporters.md#jmx)</li>
<li>[Prometheus](maintenance/observability/metric-reporters.md#prometheus)</li>
<li>[OpenTelemetry](maintenance/observability/metric-reporters.md#opentelemetry)</li>
</td>
</tr>
</tbody>
Expand All @@ -137,9 +138,7 @@ We have listed them in the table below the figure.
## How to deploy Fluss

Fluss can be deployed in three different ways:
- [Local Cluster](install-deploy/deploying-local-cluster.md)
- [Distributed Cluster](install-deploy/deploying-distributed-cluster.md)
- [Docker run / Docker Compose](install-deploy/deploying-with-docker.md)

**NOTE**:
- Local Cluster is for testing purpose only.
- [Local Cluster](install-deploy/deploying-local-cluster.md) (for testing purposes only)
- [Distributed Cluster](install-deploy/deploying-distributed-cluster.md)
- [Docker](install-deploy/deploying-with-docker.md)
47 changes: 40 additions & 7 deletions website/docs/maintenance/observability/metric-reporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ reporters will be instantiated on each CoordinatorServer and TabletServers when
Example reporter configuration that specifies multiple reporters:

```yaml
metrics.reporters: jmx,prometheus
metrics.reporters: jmx,opentelemetry
```

## Push vs. Pull
Expand Down Expand Up @@ -57,6 +57,39 @@ An example for such a list would be `cluster_id=fluss1,host=localhost,server_id=

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

### OpenTelemetry

Type: push


:::info

The OpenTelemetry metric reporter currently supports OTLP/gRPC only.

:::

Parameters:

- `metrics.reporter.opentelemetry.endpoint` - Target to which the OpenTelemetry metric reporter is going to send metrics to.
- `metrics.reporter.opentelemetry.export-interval` - (optional) Frequency of metric export by the OpenTelemetry metric reporter to the endpoint. Default: 10s.
- `metrics.reporter.opentelemetry.export-timeout` - (optional) Maximum time the OpenTelemetry metric reporter will wait for each metric export. Default: 10s.

Example configuration:

```yaml
metrics.reporters: opentelemetry
metrics.reporter.opentelemetry.endpoint: http://opentelemetry-collector:4317
```

Fluss metric types are mapped to OpenTelemetry metric types as follows:

| Fluss | OpenTelemetry | Note |
|-----------|-------------------------|---------------------------------------------------------------|
| Counter | LONG_SUM | |
| Gauge | LONG_GAUGE/DOUBLE_GAUGE | Automatically determined by the type of the Gauge. |
| Histogram | SUMMARY | Quantiles .5, .75, .95, .99 |
| Meter | LONG_SUM, DOUBLE_GAUGE | Exports the meter's count (LONG_SUM) and rate (DOUBLE_GAUGE). |

### Prometheus

Type: pull
Expand All @@ -74,9 +107,9 @@ metrics.reporter.prometheus.port: 9250

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

| Fluss | Prometheus | Note |
| --------- |------------|------------------------------------------|
| Counter | Gauge |Prometheus counters cannot be decremented.|
| Gauge | Gauge |Only numbers and booleans are supported. |
| Histogram | Summary |Quantiles .5, .75, .95, .98, .99 and .999 |
| Meter | Gauge |The gauge exports the meter's rate. |
| Fluss | Prometheus | Note |
|-----------|------------|--------------------------------------------|
| Counter | Gauge | Prometheus counters cannot be decremented. |
| Gauge | Gauge | Only numbers and booleans are supported. |
| Histogram | Summary | Quantiles .5, .75, .95, .98, .99 and .999 |
| Meter | Gauge | The gauge exports the meter's rate. |
216 changes: 0 additions & 216 deletions website/docs/maintenance/observability/quickstart.md

This file was deleted.

3 changes: 1 addition & 2 deletions website/docs/quickstart/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ to check whether all containers are running properly.
You can also visit http://localhost:8083/ to see if Flink is running normally.

:::note
- If you want to additionally use an observability stack, follow one of the provided quickstart guides [here](maintenance/observability/quickstart.md) and then continue with this guide.
- If you want to run with your own Flink environment, remember to download the [fluss-flink connector jar](/downloads), [flink-connector-faker](https://github.com/knaufk/flink-faker/releases), [paimon-flink connector jar](https://paimon.apache.org/docs/1.0/flink/quick-start/) and then put them to `FLINK_HOME/lib/`.
- All the following commands involving `docker compose` should be executed in the created working directory that contains the `docker-compose.yml` file.
:::
Expand Down Expand Up @@ -508,4 +507,4 @@ docker compose down -v
to stop all containers.

## Learn more
Now that you're up and running with Fluss and Flink, check out the [Apache Flink Engine](engine-flink/getting-started.md) docs to learn more features with Flink or [this guide](/maintenance/observability/quickstart.md) to learn how to set up an observability stack for Fluss and Flink.
Now that you're up and running with Fluss and Flink, you may want to check out the [Apache Flink Engine](engine-flink/getting-started.md) docs to learn more features with Flink.
Loading
Loading