You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by pn...@apache.org on 2025/07/09 08:41:26 UTC
(flink) 06/08: [hotfix][docs] Fix a couple of bugs in the documentation of traces
This is an automated email from the ASF dual-hosted git repository.
pnowojski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 5050dbe7d8cca27e77d1b025467958d001e63cab
Author: Piotr Nowojski <pi...@gmail.com>
AuthorDate: Mon May 26 16:43:30 2025 +0200
[hotfix][docs] Fix a couple of bugs in the documentation of traces
---
docs/content.zh/docs/deployment/trace_reporters.md | 19 ++++++++++++++++++-
docs/content.zh/docs/ops/traces.md | 4 ++--
docs/content/docs/deployment/trace_reporters.md | 4 ++--
docs/content/docs/ops/traces.md | 4 ++--
4 files changed, 24 insertions(+), 7 deletions(-)
diff --git a/docs/content.zh/docs/deployment/trace_reporters.md b/docs/content.zh/docs/deployment/trace_reporters.md
index 3aeacbfe40c..43da0e1368e 100644
--- a/docs/content.zh/docs/deployment/trace_reporters.md
+++ b/docs/content.zh/docs/deployment/trace_reporters.md
@@ -49,7 +49,7 @@ traces.reporter.otel.factory.class: org.apache.flink.common.metrics.OpenTelemetr
traces.reporter.otel.exporter.endpoint: http://127.0.0.1:1337
traces.reporter.otel.scope.variables.additional: region:eu-west-1,environment:local,flink_runtime:1.17.1
-traces.reporter.my_other_otel.factory.class: org.apache.flink.common.metrics.OpenTelemetryTraceReporterFactory
+traces.reporter.my_other_otel.factory.class: org.apache.flink.common.traces.OpenTelemetryTraceReporterFactory
traces.reporter.my_other_otel.exporter.endpoint: http://196.168.0.1:31337
```
@@ -64,6 +64,23 @@ Be careful that all the method must not block for a significant amount of time,
The following sections list the supported reporters.
+### OpenTelemetry
+#### (org.apache.flink.traces.otel.OpenTelemetryTraceReporterFactory)
+
+`OpenTelemetryTraceReporterFactory` currently supports only gRPC.
+
+Parameters:
+
+{{< include_reporter_config "layouts/shortcodes/generated/open_telemetry_reporter_configuration.html" >}}
+
+Example configuration:
+
+```yaml
+traces.reporter.otel.factory.class: org.apache.flink.traces.otel.OpenTelemetryTraceReporterFactory
+traces.reporter.otel.exporter.endpoint: http://127.0.0.1:1337
+```
+
+
### Slf4j
#### (org.apache.flink.traces.slf4j.Slf4jTraceReporter)
diff --git a/docs/content.zh/docs/ops/traces.md b/docs/content.zh/docs/ops/traces.md
index 393551074f6..1dfa6938687 100644
--- a/docs/content.zh/docs/ops/traces.md
+++ b/docs/content.zh/docs/ops/traces.md
@@ -38,10 +38,10 @@ This method returns a `MetricGroup` object via which you can report a new single
### Reporting single Span
-A `Span` represents something that happened in Flink at certain point of time, that will be reported to a `TraceReporter`.
+A `Span` represents some process that happened in Flink at certain point of time for a certain duration, that will be reported to a `TraceReporter`.
To report a `Span` you can use the `MetricGroup#addSpan(SpanBuilder)` method.
-Currently we don't support traces with multiple spans. Each `Span` is self-contained and represents things like a checkpoint or recovery.
+Currently, we don't support traces with multiple spans. Each `Span` is self-contained and represents things like a checkpoint or recovery.
{{< tabs "9612d275-bdda-4322-a01f-ae6da805e917" >}}
{{< tab "Java" >}}
```java
diff --git a/docs/content/docs/deployment/trace_reporters.md b/docs/content/docs/deployment/trace_reporters.md
index c310a54f69e..d8881aa2c5a 100644
--- a/docs/content/docs/deployment/trace_reporters.md
+++ b/docs/content/docs/deployment/trace_reporters.md
@@ -49,7 +49,7 @@ traces.reporter.otel.factory.class: org.apache.flink.traces.otel.OpenTelemetryTr
traces.reporter.otel.exporter.endpoint: http://127.0.0.1:1337
traces.reporter.otel.scope.variables.additional: region:eu-west-1,environment:local,flink_runtime:1.17.1
-traces.reporter.my_other_otel.factory.class: org.apache.flink.common.metrics.OpenTelemetryTraceReporterFactory
+traces.reporter.my_other_otel.factory.class: org.apache.flink.common.traces.OpenTelemetryTraceReporterFactory
traces.reporter.my_other_otel.exporter.endpoint: http://196.168.0.1:31337
```
@@ -76,7 +76,7 @@ Parameters:
Example configuration:
```yaml
-traces.reporter.otel.factory.class: org.apache.flink.metrics.otel.OpenTelemetryTraceReporterFactory
+traces.reporter.otel.factory.class: org.apache.flink.traces.otel.OpenTelemetryTraceReporterFactory
traces.reporter.otel.exporter.endpoint: http://127.0.0.1:1337
```
diff --git a/docs/content/docs/ops/traces.md b/docs/content/docs/ops/traces.md
index 393551074f6..1dfa6938687 100644
--- a/docs/content/docs/ops/traces.md
+++ b/docs/content/docs/ops/traces.md
@@ -38,10 +38,10 @@ This method returns a `MetricGroup` object via which you can report a new single
### Reporting single Span
-A `Span` represents something that happened in Flink at certain point of time, that will be reported to a `TraceReporter`.
+A `Span` represents some process that happened in Flink at certain point of time for a certain duration, that will be reported to a `TraceReporter`.
To report a `Span` you can use the `MetricGroup#addSpan(SpanBuilder)` method.
-Currently we don't support traces with multiple spans. Each `Span` is self-contained and represents things like a checkpoint or recovery.
+Currently, we don't support traces with multiple spans. Each `Span` is self-contained and represents things like a checkpoint or recovery.
{{< tabs "9612d275-bdda-4322-a01f-ae6da805e917" >}}
{{< tab "Java" >}}
```java