Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[i18n] Convert docs/exporter shortcodes into includes #6581

Merged
merged 8 commits into from
Mar 20, 2025
Merged
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
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
{{ $lang := .Get 0 -}} {{ $spanExporterInterfaceUrl := .Get 1 }}

## Custom exporters

Finally, you can also write your own exporter. For more information, see the
[SpanExporter Interface in the API
documentation]({{ $spanExporterInterfaceUrl }}).
[SpanExporter Interface in the API documentation]({{ $1 }}).

## Batching span and log records

The OpenTelemetry SDK provides a set of default span and log record processors,
that allow you to either emit spans one-by-on ("simple") or batched. Using
batching is recommended, but if you do not want to batch your spans or log
records, you can use a simple processor instead as follows:

{{ .Inner }}
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Prometheus text format on request.

### Backend Setup {#prometheus-setup}

<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
{{% alert-md title=Note color=info %}}

If you have Prometheus or a Prometheus-compatible backend already set up, you
can skip this section and setup the [Prometheus](#prometheus-dependencies) or
[OTLP](#otlp-dependencies) exporter dependencies for your application.

</div>
{{% /alert-md %}}

You can run [Prometheus](https://prometheus.io) in a docker container,
accessible on port `9090` by following these instructions:
Expand All @@ -35,7 +35,7 @@ Run Prometheus in a docker container with the UI accessible on port `9090`:
docker run --rm -v ${PWD}/prometheus.yml:/prometheus/prometheus.yml -p 9090:9090 prom/prometheus --enable-feature=otlp-write-receive
```

<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
{{% alert-md title=Note color=info %}}

When using Prometheus' OTLP Receiver, make sure that you set the OTLP endpoint
for metrics in your application to `http://localhost:9090/api/v1/otlp`.
Expand All @@ -44,4 +44,4 @@ Not all docker environments support `host.docker.internal`. In some cases you
may need to replace `host.docker.internal` with `localhost` or the IP address of
your machine.

</div>
{{% /alert-md %}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

### Backend Setup {#zipkin-setup}

<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
{{% alert-md title=Note color=info %}}

If you have Zipkin or a Zipkin-compatible backend already set up, you can skip
this section and setup the [Zipkin exporter dependencies](#zipkin-dependencies)
for your application.

</div>
{{% /alert-md %}}

You can run [Zipkin](https://zipkin.io/) on in a Docker container by executing
the following command:
Expand Down
10 changes: 4 additions & 6 deletions content/en/docs/languages/cpp/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,9 +265,9 @@ void InitLogger()
}
```

{{% docs/languages/exporters/jaeger %}}
{{% include "exporters/jaeger.md" %}}

{{% docs/languages/exporters/prometheus-setup %}}
{{% include "exporters/prometheus-setup.md" %}}

### Dependencies {#prometheus-dependencies}

Expand Down Expand Up @@ -310,7 +310,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
the metrics from this endpoint.

{{% docs/languages/exporters/zipkin-setup %}}
{{% include "exporters/zipkin-setup.md" %}}

### Dependencies {#zipkin-dependencies}

Expand Down Expand Up @@ -353,7 +353,7 @@ void InitTracer()
}
```

{{% docs/languages/exporters/outro python `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
{{% include "exporters/outro.md" `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}

{{< tabpane text=true >}} {{% tab Batch %}}

Expand Down Expand Up @@ -383,5 +383,3 @@ auto processor = opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(s
```

{{< /tab >}} {{< /tabpane>}}

{{% /docs/languages/exporters/outro %}}
10 changes: 4 additions & 6 deletions content/en/docs/languages/js/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,9 +239,9 @@ package and the `ConsoleMetricExporter` is included in the
[`@opentelemetry/sdk-metrics`](https://www.npmjs.com/package/@opentelemetry/sdk-metrics)
package:

{{% docs/languages/exporters/jaeger %}}
{{% include "exporters/jaeger.md" %}}

{{% docs/languages/exporters/prometheus-setup %}}
{{% include "exporters/prometheus-setup.md" %}}

### Dependencies {#prometheus-dependencies}

Expand Down Expand Up @@ -296,7 +296,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
the metrics from this endpoint.

{{% docs/languages/exporters/zipkin-setup %}}
{{% include "exporters/zipkin-setup.md" %}}

### Dependencies {#zipkin-dependencies}

Expand Down Expand Up @@ -345,7 +345,7 @@ const sdk = new opentelemetry.NodeSDK({

{{% /tab %}} {{< /tabpane >}}

{{% docs/languages/exporters/outro js `https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_trace_base.SpanExporter.html` %}}
{{% include "exporters/outro.md" `https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_trace_base.SpanExporter.html` %}}

{{< tabpane text=true >}} {{% tab TypeScript %}}

Expand Down Expand Up @@ -379,8 +379,6 @@ sdk.start();

{{% /tab %}} {{< /tabpane >}}

{{% /docs/languages/exporters/outro %}}

[content security policies]:
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/
[cross-origin resource sharing]:
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/languages/net/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,9 @@ var loggerFactory = LoggerFactory.Create(builder =>
});
```

{{% docs/languages/exporters/jaeger %}}
{{% include "exporters/jaeger.md" %}}

{{% docs/languages/exporters/prometheus-setup %}}
{{% include "exporters/prometheus-setup.md" %}}

### Dependencies {#prometheus-dependencies}

Expand Down Expand Up @@ -292,7 +292,7 @@ app.UseOpenTelemetryPrometheusScrapingEndpoint();
Further details on configuring the Prometheus exporter can be found
[here](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md).

{{% docs/languages/exporters/zipkin-setup %}}
{{% include "exporters/zipkin-setup.md" %}}

### Dependencies {#zipkin-dependencies}

Expand Down
10 changes: 4 additions & 6 deletions content/en/docs/languages/python/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,9 @@ variable to `CUMULATIVE`.

{{% /alert %}}

{{% docs/languages/exporters/jaeger %}}
{{% include "exporters/jaeger.md" %}}

{{% docs/languages/exporters/prometheus-setup %}}
{{% include "exporters/prometheus-setup.md" %}}

### Dependencies {#prometheus-dependencies}

Expand Down Expand Up @@ -233,7 +233,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
the metrics from this endpoint.

{{% docs/languages/exporters/zipkin-setup %}}
{{% include "exporters/zipkin-setup.md" %}}

### Dependencies {#zipkin-dependencies}

Expand Down Expand Up @@ -306,13 +306,11 @@ trace.set_tracer_provider(provider)

{{% /tab %}} {{< /tabpane >}}

{{% docs/languages/exporters/outro python `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}
{{% include "exporters/outro.md" `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}

```python
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="your-endpoint-here"))
```

{{% /docs/languages/exporters/outro %}}
12 changes: 5 additions & 7 deletions content/pt/docs/languages/python/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Exporters
weight: 50
description: Processar e exportar seus dados de telemetria
default_lang_commit: 546f3e88ca3673de8aad69358d416256d1fe6411
default_lang_commit: 546f3e88ca3673de8aad69358d416256d1fe6411 # patched
cSpell:ignore: LOWMEMORY
---

Expand Down Expand Up @@ -192,9 +192,9 @@ esta variável de ambiente como `CUMULATIVE`.

{{% /alert %}}

{{% docs/languages/exporters/jaeger %}}
{{% include "exporters/jaeger.md" %}}

{{% docs/languages/exporters/prometheus-setup %}}
{{% include "exporters/prometheus-setup.md" %}}

### Dependências {#prometheus-dependencies}

Expand Down Expand Up @@ -235,7 +235,7 @@ Com o código acima, você pode acessar suas métricas em
<http://localhost:9464/metrics>. O Prometheus ou um OpenTelemetry Collector com
o receptor Prometheus pode extrair as métricas deste endpoint.

{{% docs/languages/exporters/zipkin-setup %}}
{{% include "exporters/zipkin-setup.md" %}}

### Dependências {#zipkin-dependencies}

Expand Down Expand Up @@ -308,13 +308,11 @@ trace.set_tracer_provider(provider)

{{% /tab %}} {{< /tabpane >}}

{{% docs/languages/exporters/outro python `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}
{{% include "exporters/outro.md" `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}

```python
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="seu-endpoint-aqui"))
```

{{% /docs/languages/exporters/outro %}}