morazow commented on code in PR #2711:
URL: https://github.com/apache/fluss/pull/2711#discussion_r2873873803
##########
helm/README.md:
##########
@@ -93,6 +93,48 @@ Important Fluss options surfaced by the chart:
- internal.listener.name: Which listener is used for internal communication
(defaults to INTERNAL).
- tablet-server.id: Required to be unique per TabletServer. The chart
auto‑derives this from the StatefulSet pod ordinal at runtime.
+### Metrics and Prometheus scraping
+
+The chart can enable Fluss metrics reporters and add scrape annotations to
Services.
+
+Example:
+
+```bash
+helm install fluss ./fluss-helm \
+ --set metrics.enabled=true
+```
+
+When enabled, the chart will:
+- configure `metrics.reporters` from reporter names in values
+- configure `metrics.reporter.<name>.<option>` entries from values
+- optionally add metrics scrape annotations to Fluss Services from values
+
+Values:
+
+| Key | Description |
+| --- | --- |
+| `metrics.enabled` | Enables metrics reporting and endpoint exposure. |
+| `metrics.reporters` | Map of Fluss metric reporters and their options. |
+| `metrics.annotations` | Optional map of annotations rendered on Fluss
Services when metrics are enabled. |
+
+Example `values.yaml` snippet:
+
+```yaml
+metrics:
+ enabled: true
+ reporters:
+ grph:
+ port: 9020
+ host: example-localhost
+ protocol: TCP
+ interval: "60 SECONDS"
+ prometheus:
+ port: 9249
+ annotations:
Review Comment:
@affo thanks for the review 🙏
On the bitnami charts, they have separate annotations for metrics (under
`metrics.service`):
```
metrics.service.annotations | Annotations for Prometheus to auto-discover
the metrics endpoint | {}
```
https://github.com/bitnami/charts/blob/main/bitnami/zookeeper/values.yaml#L826-L844
But I agree, we would common and pod annotations later on.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
