Skip to content

Commit fb40e74

Browse files
authored
[IA] More shortcodes for exporter pages (#3931)
1 parent 89f1b60 commit fb40e74

29 files changed

+242
-507
lines changed

.cspell.yml

+1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ words:
111111
- otep
112112
- otlp
113113
- overridable
114+
- outro
114115
- packagist
115116
- Paixão
116117
- parentbased

content/en/blog/2022/debug-otel-with-otel/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -261,5 +261,5 @@ COPY opentelemetry_module.conf /etc/nginx/conf.d
261261
[v1.0.1 release of the otel-webserver-module]:
262262
https://github.com/open-telemetry/opentelemetry-cpp-contrib/releases/tag/webserver%2Fv1.0.1
263263
[java]:
264-
/docs/languages/java/automatic/agent-config/#capturing-http-request-and-response-headers
264+
/docs/languages/java/automatic/configuration/#capturing-http-request-and-response-headers
265265
[python]: /docs/languages/python/automatic/

content/en/docs/concepts/components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ For more information, see
7373

7474
### Exporters
7575

76-
{{% docs/languages/exporters-intro all %}}
76+
{{% docs/languages/exporters/intro all %}}
7777

7878
### Automatic Instrumentation
7979

content/en/docs/faas/lambda-auto-instrument.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ variables:
5656
instrumentations, see [Suppressing specific agent instrumentation][1].
5757

5858
[1]:
59-
/docs/languages/java/automatic/agent-config/#suppressing-specific-agent-instrumentation
59+
/docs/languages/java/automatic/configuration/#suppressing-specific-agent-instrumentation
6060

6161
For example, to only enable auto-instrumentation for Lambda and the AWS SDK, you
6262
would set the following environment variables:

content/en/docs/kubernetes/operator/automatic.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ the default libraries by setting
222222
`OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED=false` and then use
223223
`OTEL_INSTRUMENTATION_[NAME]_ENABLED=true` where `[NAME]` is the name of the
224224
library. For more details, see
225-
[Suppressing specific auto-instrumentation](/docs/languages/java/automatic/agent-config/#suppressing-specific-auto-instrumentation).
225+
[Suppressing specific auto-instrumentation](/docs/languages/java/automatic/configuration/#suppressing-specific-auto-instrumentation).
226226

227227
```yaml
228228
apiVersion: opentelemetry.io/v1alpha1
@@ -249,7 +249,7 @@ spec:
249249
#### Learn more {#java-learn-more}
250250
251251
For more details, see
252-
[Java agent Configuration](/docs/languages/java/automatic/agent-config/).
252+
[Java agent Configuration](/docs/languages/java/automatic/configuration/).
253253
254254
### Node.js
255255
@@ -393,7 +393,7 @@ spec:
393393

394394
#### Learn more {#python-learn-more}
395395

396-
[See the Python agent Configuration docs for more details.](/docs/languages/python/automatic/agent-config/#disabling-specific-instrumentations)
396+
[See the Python agent Configuration docs for more details.](/docs/languages/python/automatic/configuration/#disabling-specific-instrumentations)
397397

398398
### Go
399399

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ cSpell:ignore: chrono millis ostream
66

77
<!-- markdownlint-disable no-duplicate-heading -->
88

9-
{{% docs/languages/exporters-intro cpp %}}
9+
{{% docs/languages/exporters/intro cpp %}}
1010

1111
## Trace exporters
1212

content/en/docs/languages/erlang/exporters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ weight: 50
44
cSpell:ignore: chrono millis ostream rebar relx
55
---
66

7-
{{% docs/languages/exporters-intro erlang %}}
7+
{{% docs/languages/exporters/intro erlang %}}
88

99
## Exporting to the OpenTelemetry Collector
1010

content/en/docs/languages/go/exporters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 50
66
cSpell:ignore: otlpmetric otlpmetricgrpc otlpmetrichttp otlptrace otlptracegrpc otlptracehttp promhttp stdouttrace
77
---
88

9-
{{% docs/languages/exporters-intro go %}}
9+
{{% docs/languages/exporters/intro go %}}
1010

1111
## Console
1212

content/en/docs/languages/java/automatic/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ java -javaagent:path/to/opentelemetry-javaagent.jar \
7878
-jar myapp.jar
7979
```
8080

81-
To see the full range of configuration options, see [Agent Configuration][].
81+
To see the full range of configuration options, see
82+
[Agent Configuration](configuration).
8283

8384
## Supported libraries, frameworks, application services, and JVMs
8485

@@ -97,7 +98,6 @@ After you have automatic instrumentation configured for your app or service, you
9798
might want to [annotate](annotations) selected methods or add
9899
[manual instrumentation](../instrumentation) to collect custom telemetry data.
99100

100-
[agent configuration]: agent-config
101101
[opentelemetry-javaagent.jar]:
102102
https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar
103103
[releases]:

content/en/docs/languages/java/automatic/agent-config.md content/en/docs/languages/java/automatic/configuration.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Agent Configuration
33
linkTitle: Configuration
44
weight: 10
5+
aliases: [agent-config]
56
# prettier-ignore
67
cSpell:ignore: akka armeria classloaders couchbase Customizer datasource dbcp Dotel dropwizard dubbo finatra hikari hikaricp HSET httpasyncclient httpclient hystrix jaxrs jaxws jedis jodd kotlinx logback logmanager mojarra myfaces okhttp oshi pekko rabbitmq ratpack rediscala redisson restlet rocketmq serverlessapis spymemcached twilio vaadin vertx vibur webflux webmvc
78
---

content/en/docs/languages/java/exporters.md

+7-155
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,7 @@ weight: 50
44
cSpell:ignore: okhttp
55
---
66

7-
{{% docs/languages/exporters-intro java %}}
8-
9-
{{% alert title="Note" color="info" %}}
10-
11-
If you use the Java agent for
12-
[automatic instrumentation](/docs/languages/java/automatic) you can learn how to
13-
setup exporters following the
14-
[Agent Configuration Guide](/docs/languages/java/automatic/agent-config)
15-
16-
{{% /alert %}}
17-
18-
## OTLP
19-
20-
### Collector Setup
21-
22-
{{% alert title="Note" color="info" %}}
23-
24-
If you have a OTLP collector or backend already set up, you can skip this
25-
section and [setup the OTLP exporter dependencies](#otlp-dependencies) for your
26-
application.
27-
28-
{{% /alert %}}
29-
30-
To try out and verify your OTLP exporters, you can run the collector in a docker
31-
container that writes telemetry directly to the console.
32-
33-
In an empty directory, create a file called `collector-config.yaml` with the
34-
following content:
35-
36-
```yaml
37-
receivers:
38-
otlp:
39-
protocols:
40-
grpc:
41-
http:
42-
exporters:
43-
debug:
44-
verbosity: detailed
45-
service:
46-
pipelines:
47-
traces:
48-
receivers: [otlp]
49-
exporters: [debug]
50-
metrics:
51-
receivers: [otlp]
52-
exporters: [debug]
53-
logs:
54-
receivers: [otlp]
55-
exporters: [debug]
56-
```
57-
58-
Now run the collector in a docker container:
59-
60-
```shell
61-
docker run -p 4317:4317 -p 4318:4318 --rm -v $(pwd)/collector-config.yaml:/etc/otelcol/config.yaml otel/opentelemetry-collector
62-
```
63-
64-
This collector is now able to accept telemetry via OTLP. Later you may want to
65-
[configure the collector](/docs/collector/configuration) to send your telemetry
66-
to your observability backend.
7+
{{% docs/languages/exporters/intro java %}}
678

689
### Dependencies {#otlp-dependencies}
6910

@@ -241,72 +182,9 @@ all you need to do is update your environment variables:
241182
env OTEL_TRACES_EXPORTER=logging OTEL_METRICS_EXPORTER=logging OTEL_LOGS_EXPORTER=logging java -jar ./build/libs/java-simple.jar
242183
```
243184

244-
## Jaeger
245-
246-
[Jaeger](https://www.jaegertracing.io/) natively supports OTLP to receive trace
247-
data. You can run Jaeger in a docker container with the UI accessible on port
248-
16686 and OTLP enabled on ports 4137 and 4138:
249-
250-
```shell
251-
docker run --rm \
252-
-e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
253-
-p 16686:16686 \
254-
-p 4317:4317 \
255-
-p 4318:4318 \
256-
-p 9411:9411 \
257-
jaegertracing/all-in-one:latest
258-
```
259-
260-
Now following the instruction to setup the [OTLP exporters](#otlp-dependencies).
261-
262-
## Prometheus
263-
264-
To send your metric data to [Prometheus](https://prometheus.io/), you can either
265-
[enable Prometheus' OTLP Receiver](https://prometheus.io/docs/prometheus/latest/feature_flags/#otlp-receiver)
266-
and use the [OTLP exporter](#otlp) or you can use the
267-
[`PrometheusHttpServer`](https://javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-prometheus/latest/io/opentelemetry/exporter/prometheus/PrometheusHttpServer.html),
268-
a `MetricReader`, that starts an HTTP server that will collect metrics and
269-
serialize to Prometheus text format on request.
270-
271-
### Backend Setup {#prometheus-setup}
272-
273-
{{% alert title="Note" color="info" %}}
274-
275-
If you have Prometheus or a Prometheus-compatible backend already set up, you
276-
can skip this section and setup the [Prometheus](#prometheus-dependencies) or
277-
[OTLP](#otlp-dependencies) exporter dependencies for your application.
278-
279-
{{% /alert %}}
280-
281-
You can run [Prometheus](https://prometheus.io) in a docker container,
282-
accessible on port `9090` by following these instructions:
283-
284-
Create a file called `prometheus.yml` with the following content:
285-
286-
```yaml
287-
scrape_configs:
288-
- job_name: dice-service
289-
scrape_interval: 5s
290-
static_configs:
291-
- targets: [host.docker.internal:9464]
292-
```
185+
{{% docs/languages/exporters/jaeger %}}
293186

294-
Run Prometheus in a docker container with the UI accessible on port `9090`:
295-
296-
```shell
297-
docker run --rm -v ${PWD}/prometheus.yml:/prometheus/prometheus.yml -p 9090:9090 prom/prometheus --enable-feature=otlp-write-receive
298-
```
299-
300-
{{% alert title="Note" color="info" %}}
301-
302-
When using Prometheus' OTLP Receiver, make sure that you set the OTLP endpoint
303-
for metrics in your application to `http://localhost:9090/api/v1/otlp`.
304-
305-
Not all docker environments support `host.docker.internal`. In some cases you
306-
may need to replace `host.docker.internal` with `localhost` or the IP address of
307-
your machine.
308-
309-
{{% /alert %}}
187+
{{% docs/languages/exporters/prometheus-setup %}}
310188

311189
### Dependencies {#prometheus-dependencies}
312190

@@ -354,24 +232,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
354232
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
355233
the metrics from this endpoint.
356234

357-
## Zipkin
358-
359-
### Backend Setup {#zipkin-setup}
360-
361-
{{% alert title="Note" color="info" %}}
362-
363-
If you have Zipkin or a Zipkin-compatible backend already set up, you can skip
364-
this section and setup the [Zipkin exporter dependencies](#zipkin-dependencies)
365-
for your application.
366-
367-
{{% /alert %}}
368-
369-
You can run [Zipkin](https://zipkin.io/) on ina Docker container by executing
370-
the following command:
371-
372-
```shell
373-
docker run --rm -d -p 9411:9411 --name zipkin openzipkin/zipkin
374-
```
235+
{{% docs/languages/exporters/zipkin-setup %}}
375236

376237
### Dependencies {#zipkin-dependencies}
377238

@@ -417,18 +278,7 @@ SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
417278
.build();
418279
```
419280

420-
## Other available exporters
421-
422-
There are many other exporters available. For a list of available exporters, see
423-
the [registry](/ecosystem/registry/?component=exporter&language=java).
424-
425-
Finally, you can also write your own exporter. For more information, see the
426-
[SpanExporter Interface in the API documentation](https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/latest/io/opentelemetry/sdk/trace/export/SpanExporter.html).
427-
428-
## Batching spans and log records
429-
430-
For traces the OpenTelemetry SDK provides a set of default span and log record
431-
processors, that allow you to either emit them one-by-one ("simple") or batched:
281+
{{% docs/languages/exporters/outro java "https://javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/latest/io/opentelemetry/sdk/trace/export/SpanExporter.html" %}}
432282

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

@@ -467,3 +317,5 @@ SdkLoggerProvider sdkLoggerProvider = SdkLoggerProvider.builder()
467317
```
468318

469319
{{< /tab >}} {{< /tabpane>}}
320+
321+
{{% /docs/languages/exporters/outro %}}

content/en/docs/languages/java/libraries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ telemetry data for a library or framework.
1717
The Java agent for automatic instrumentation includes instrumentation libraries
1818
for many common Java frameworks. Most are turned on by default. If you need to
1919
turn off certain instrumentation libraries, you can
20-
[suppress them](../automatic/agent-config/#suppressing-specific-auto-instrumentation).
20+
[suppress them](../automatic/configuration/#suppressing-specific-auto-instrumentation).
2121

2222
If you use [code-based instrumentation](../instrumentation), you can leverage
2323
some instrumentation libraries for your dependencies standalone. To find out

content/en/docs/languages/java/resources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cSpell:ignore: getenv myhost SIGINT uuidgen WORKDIR
99
If you use the Java agent for
1010
[automatic instrumentation](/docs/languages/java/automatic) you can learn how to
1111
setup resource detection following the
12-
[Agent Configuration Guide](/docs/languages/java/automatic/agent-config).
12+
[Agent Configuration Guide](/docs/languages/java/automatic/configuration).
1313

1414
For manual instrumentation, you will find some introductions on how to set up
1515
resource detection below.

content/en/docs/languages/js/automatic/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ used. You can use the environment variable `OTEL_NODE_RESOURCE_DETECTORS` to
5151
enable only certain detectors, or to completely disable them.
5252

5353
To see the full range of configuration options, see
54-
[Module Configuration](module-config).
54+
[Module Configuration](configuration).
5555

5656
## Supported libraries and frameworks
5757

content/en/docs/languages/js/automatic/module-config.md content/en/docs/languages/js/automatic/configuration.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Automatic Instrumentation Configuration
33
linkTitle: Configuration
44
description: Learn how to configure Automatic Instrumentation for Node.js
5+
aliases: [module-config]
56
weight: 10
67
---
78

0 commit comments

Comments
 (0)