Skip to content

Commit 7d0c3f2

Browse files
chalinchalin
authored
[i18n] Convert docs/exporter shortcodes into includes (#6581)
1 parent 7397b6d commit 7d0c3f2

File tree

9 files changed

+27
-40
lines changed

9 files changed

+27
-40
lines changed

‎layouts/shortcodes/docs/languages/exporters/jaeger.md ‎content/en/docs/languages/_includes/exporters/jaeger.md

File renamed without changes.

‎layouts/shortcodes/docs/languages/exporters/outro.md ‎content/en/docs/languages/_includes/exporters/outro.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
{{ $lang := .Get 0 -}} {{ $spanExporterInterfaceUrl := .Get 1 }}
2-
31
## Custom exporters
42

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

96
## Batching span and log records
107

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

‎layouts/shortcodes/docs/languages/exporters/prometheus-setup.md ‎content/en/docs/languages/_includes/exporters/prometheus-setup.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Prometheus text format on request.
88

99
### Backend Setup {#prometheus-setup}
1010

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

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

17-
</div>
17+
{{% /alert-md %}}
1818

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

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

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

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

‎layouts/shortcodes/docs/languages/exporters/zipkin-setup.md ‎content/en/docs/languages/_includes/exporters/zipkin-setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
### Backend Setup {#zipkin-setup}
44

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

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

11-
</div>
11+
{{% /alert-md %}}
1212

1313
You can run [Zipkin](https://zipkin.io/) on in a Docker container by executing
1414
the following command:

‎content/en/docs/languages/cpp/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,9 @@ void InitLogger()
265265
}
266266
```
267267
268-
{{% docs/languages/exporters/jaeger %}}
268+
{{% include "exporters/jaeger.md" %}}
269269
270-
{{% docs/languages/exporters/prometheus-setup %}}
270+
{{% include "exporters/prometheus-setup.md" %}}
271271
272272
### Dependencies {#prometheus-dependencies}
273273
@@ -310,7 +310,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
310310
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
311311
the metrics from this endpoint.
312312
313-
{{% docs/languages/exporters/zipkin-setup %}}
313+
{{% include "exporters/zipkin-setup.md" %}}
314314
315315
### Dependencies {#zipkin-dependencies}
316316
@@ -353,7 +353,7 @@ void InitTracer()
353353
}
354354
```
355355
356-
{{% docs/languages/exporters/outro python `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
356+
{{% include "exporters/outro.md" `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
357357
358358
{{< tabpane text=true >}} {{% tab Batch %}}
359359
@@ -383,5 +383,3 @@ auto processor = opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(s
383383
```
384384

385385
{{< /tab >}} {{< /tabpane>}}
386-
387-
{{% /docs/languages/exporters/outro %}}

‎content/en/docs/languages/js/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,9 @@ package and the `ConsoleMetricExporter` is included in the
239239
[`@opentelemetry/sdk-metrics`](https://www.npmjs.com/package/@opentelemetry/sdk-metrics)
240240
package:
241241

242-
{{% docs/languages/exporters/jaeger %}}
242+
{{% include "exporters/jaeger.md" %}}
243243

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

246246
### Dependencies {#prometheus-dependencies}
247247

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

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

301301
### Dependencies {#zipkin-dependencies}
302302

@@ -345,7 +345,7 @@ const sdk = new opentelemetry.NodeSDK({
345345

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

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

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

@@ -379,8 +379,6 @@ sdk.start();
379379

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

382-
{{% /docs/languages/exporters/outro %}}
383-
384382
[content security policies]:
385383
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/
386384
[cross-origin resource sharing]:

‎content/en/docs/languages/net/exporters.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ var loggerFactory = LoggerFactory.Create(builder =>
198198
});
199199
```
200200

201-
{{% docs/languages/exporters/jaeger %}}
201+
{{% include "exporters/jaeger.md" %}}
202202

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

205205
### Dependencies {#prometheus-dependencies}
206206

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

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

297297
### Dependencies {#zipkin-dependencies}
298298

‎content/en/docs/languages/python/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,9 @@ variable to `CUMULATIVE`.
190190

191191
{{% /alert %}}
192192

193-
{{% docs/languages/exporters/jaeger %}}
193+
{{% include "exporters/jaeger.md" %}}
194194

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

197197
### Dependencies {#prometheus-dependencies}
198198

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

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

238238
### Dependencies {#zipkin-dependencies}
239239

@@ -306,13 +306,11 @@ trace.set_tracer_provider(provider)
306306

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

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

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

315315
processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="your-endpoint-here"))
316316
```
317-
318-
{{% /docs/languages/exporters/outro %}}

‎content/pt/docs/languages/python/exporters.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Exporters
33
weight: 50
44
description: Processar e exportar seus dados de telemetria
5-
default_lang_commit: 546f3e88ca3673de8aad69358d416256d1fe6411
5+
default_lang_commit: 546f3e88ca3673de8aad69358d416256d1fe6411 # patched
66
cSpell:ignore: LOWMEMORY
77
---
88

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

193193
{{% /alert %}}
194194

195-
{{% docs/languages/exporters/jaeger %}}
195+
{{% include "exporters/jaeger.md" %}}
196196

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

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

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

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

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

@@ -308,13 +308,11 @@ trace.set_tracer_provider(provider)
308308

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

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

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

317317
processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="seu-endpoint-aqui"))
318318
```
319-
320-
{{% /docs/languages/exporters/outro %}}

0 commit comments

Comments
 (0)