Skip to content

Commit d657980

Browse files
jack-bergchalin
andauthored
Move performance to java agent, merge javadoc into API page (#5590)
Co-authored-by: Patrice Chalin <[email protected]>
1 parent ccfc7d6 commit d657980

File tree

10 files changed

+1744
-1746
lines changed

10 files changed

+1744
-1746
lines changed

content/en/docs/collector/deployment/agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Cons:
129129
[instrumentation]: /docs/languages/
130130
[otlp]: /docs/specs/otel/protocol/
131131
[collector]: /docs/collector/
132-
[instrument-java-metrics]: /docs/languages/java/api-components/#meterprovider
132+
[instrument-java-metrics]: /docs/languages/java/api/#meterprovider
133133
[otlp-exporter]: /docs/specs/otel/protocol/exporter/
134134
[java-otlp-example]:
135135
https://github.com/open-telemetry/opentelemetry-java-docs/tree/main/otlp

content/en/docs/concepts/instrumentation/libraries.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,8 @@ After you create a span, pass new trace context to the application code
267267
(callback or handler), by making the span active; if possible, do this
268268
explicitly. The following Java example shows how to add trace context and
269269
activate a span. See the
270-
[Context extraction in Java](/docs/languages/java/api-components/#contextpropagators),
271-
for more examples.
270+
[Context extraction in Java](/docs/languages/java/api/#contextpropagators), for
271+
more examples.
272272

273273
```java
274274
// extract the context

content/en/docs/languages/java/api-components.md

-1,688
This file was deleted.

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

+1,693-6
Large diffs are not rendered by default.

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

+3-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ cSpell:ignore: authservice autoconfigured blrp Customizer Dotel ignore LOWMEMORY
1111
<?code-excerpt path-base="examples/java/configuration"?>
1212

1313
The [SDK](../sdk/) is the built-in reference implementation of the
14-
[API](../api-components/), processing and exporting telemetry produced by
15-
instrumentation API calls. Configuring the SDK to process and export
16-
appropriately is an essential step to integrating OpenTelemetry into an
17-
application.
14+
[API](../api/), processing and exporting telemetry produced by instrumentation
15+
API calls. Configuring the SDK to process and export appropriately is an
16+
essential step to integrating OpenTelemetry into an application.
1817

1918
All SDK components have
2019
[programmatic configuration APIs](#programmatic-configuration). This is the most

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

+19-23
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ cSpell:ignore: Logback logback
1313

1414
<!-- markdownlint-disable no-duplicate-heading -->
1515

16-
Instrumentation records telemetry using the [API](../api-components/). The
17-
[SDK](../sdk/) is the built-in reference implementation of the API, and is
16+
Instrumentation records telemetry using the [API](../api/). The [SDK](../sdk/)
17+
is the built-in reference implementation of the API, and is
1818
[configured](../configuration/) to process and export the telemetry produced by
1919
instrumentation API calls. This page discusses the OpenTelemetry ecosystem in
2020
OpenTelemetry Java, including resources for end users and cross-cutting
@@ -100,8 +100,8 @@ Instrumentation" column on
100100

101101
[Native instrumentation](/docs/specs/otel/glossary/#natively-instrumented) is
102102
built directly into libraries or frameworks. OpenTelemetry encourages library
103-
authors to add native instrumentation using the [API](../api-components/). In
104-
the long term, we hope the native instrumentation becomes the norm, and view the
103+
authors to add native instrumentation using the [API](../api/). In the long
104+
term, we hope the native instrumentation becomes the norm, and view the
105105
instrumentation maintained by OpenTelemetry in
106106
[opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
107107
as a temporary means of filling the gap.
@@ -152,20 +152,17 @@ context:
152152

153153
For this correlation to work, trace context must be propagated throughout an
154154
application (across function calls and threads), and across application
155-
boundaries. The [context API](../api-components/#context-api) facilitates this.
155+
boundaries. The [context API](../api/#context-api) facilitates this.
156156
Instrumentation needs to be written in a manner which is context aware:
157157

158158
- Libraries that represent the entry point to an application (i.e. HTTP servers,
159-
message consumers, etc.) should
160-
[extract context](../api-components/#contextpropagators) from incoming
161-
messages.
159+
message consumers, etc.) should [extract context](../api/#contextpropagators)
160+
from incoming messages.
162161
- Libraries that represent an exit point from an application (i.e. HTTP clients,
163-
message producers, etc.) should
164-
[inject context](../api-components/#contextpropagators) into outgoing
165-
messages.
166-
- Libraries should implicitly or explicitly pass
167-
[Context](../api-components/#context) through the callstack and across any
168-
threads.
162+
message producers, etc.) should [inject context](../api/#contextpropagators)
163+
into outgoing messages.
164+
- Libraries should implicitly or explicitly pass [Context](../api/#context)
165+
through the callstack and across any threads.
169166

170167
## Semantic conventions
171168

@@ -177,21 +174,20 @@ attribute key, value, and requirement levels.
177174
When writing instrumentation, consult the semantic conventions and conform to
178175
any which are applicable to the domain.
179176

180-
OpenTelemetry Java [publishes artifacts](../api-components/#semantic-attributes)
181-
to assist in conforming to the semantic conventions, including generated
182-
constants for attribute keys and values.
177+
OpenTelemetry Java [publishes artifacts](../api/#semantic-attributes) to assist
178+
in conforming to the semantic conventions, including generated constants for
179+
attribute keys and values.
183180

184181
TODO: discuss instrumentation API and how it helps conform to semantic
185182
conventions
186183

187184
## Log instrumentation
188185

189-
While the [LoggerProvider](../api-components/#loggerprovider) /
190-
[Logger](../api-components/#logger) APIs are structurally similar to the
191-
equivalent [trace](../api-components/#tracerprovider) and
192-
[metric](../api-components/#meterprovider) APIs, they serve a different use
193-
case. As of now, `LoggerProvider` / `Logger` and associated classes represent
194-
the [Log Bridge API](/docs/specs/otel/logs/api/), which exists to write log
186+
While the [LoggerProvider](../api/#loggerprovider) / [Logger](../api/#logger)
187+
APIs are structurally similar to the equivalent [trace](../api/#tracerprovider)
188+
and [metric](../api/#meterprovider) APIs, they serve a different use case. As of
189+
now, `LoggerProvider` / `Logger` and associated classes represent the
190+
[Log Bridge API](/docs/specs/otel/logs/api/), which exists to write log
195191
appenders to bridge logs recorded through other log APIs / frameworks into
196192
OpenTelemetry. They are not intended for end user use as a replacement for Log4j
197193
/ SLF4J / Logback / etc.

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The OpenTelemetry Java documentation is organized as follows:
4545
Java instrumentation ecosystem. This is a key resource for application authors
4646
looking to integrate OpenTelemetry Java into applications. Learn about the
4747
different categories of instrumentation, and decide which is right for you.
48-
- [Record Telemetry with API](../api-components/): A technical reference for the
48+
- [Record Telemetry with API](../api/): A technical reference for the
4949
OpenTelemetry API, exploring all key aspects of the API with working code
5050
examples. Most users will use this page like an encyclopedia, consulting the
5151
index of sections as needed, rather than reading front to back.
@@ -62,7 +62,8 @@ The OpenTelemetry Java documentation is organized as follows:
6262
sections as needed, rather than reading front to back.
6363
- **Learn More**: Supplementary resources, including end-to-end
6464
[examples](../examples/), [Javadoc](../api/), component
65-
[registry](../registry/), and a [performance reference](../performance/).
65+
[registry](../registry/), and a
66+
[performance reference](/docs/zero-code/java/agent/performance/).
6667

6768
## Repositories
6869

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

+14-17
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ cSpell:ignore: autoconfigured FQCNs Interceptable Logback okhttp
77
<!-- markdownlint-disable blanks-around-fences -->
88
<?code-excerpt path-base="examples/java/configuration"?>
99

10-
The SDK is the built-in reference implementation of the
11-
[API](../api-components/), processing and exporting telemetry produced by
12-
instrumentation API calls. This page is a conceptual overview of the SDK,
13-
including descriptions, links to relevant Javadocs, artifact coordinates, sample
14-
programmatic configurations and more. See
15-
**[Configure the SDK](../configuration/)** for details on SDK configuration,
16-
including
10+
The SDK is the built-in reference implementation of the [API](../api/),
11+
processing and exporting telemetry produced by instrumentation API calls. This
12+
page is a conceptual overview of the SDK, including descriptions, links to
13+
relevant Javadocs, artifact coordinates, sample programmatic configurations and
14+
more. See **[Configure the SDK](../configuration/)** for details on SDK
15+
configuration, including
1716
[zero-code SDK autoconfigure](../configuration/#zero-code-sdk-autoconfigure).
1817

1918
The SDK consists of the following top level components:
@@ -74,8 +73,8 @@ component section includes:
7473
### OpenTelemetrySdk
7574

7675
[OpenTelemetrySdk](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk/latest/io/opentelemetry/sdk/OpenTelemetrySdk.html)
77-
is the SDK implementation of [OpenTelemetry](../api-components/#opentelemetry).
78-
It is a holder for top-level SDK components which makes it convenient to pass
76+
is the SDK implementation of [OpenTelemetry](../api/#opentelemetry). It is a
77+
holder for top-level SDK components which makes it convenient to pass
7978
fully-configured SDK components to instrumentation.
8079

8180
`OpenTelemetrySdk` is configured by the application owner, and consists of:
@@ -151,9 +150,8 @@ public class ResourceConfig {
151150
### SdkTracerProvider
152151

153152
[SdkTracerProvider](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-trace/latest/io/opentelemetry/sdk/trace/SdkTracerProvider.html)
154-
is the SDK implementation of
155-
[TracerProvider](../api-components/#tracerprovider), and is responsible for
156-
handling trace telemetry produced by the API.
153+
is the SDK implementation of [TracerProvider](../api/#tracerprovider), and is
154+
responsible for handling trace telemetry produced by the API.
157155

158156
`SdkTracerProvider` is configured by the application owner, and consists of:
159157

@@ -560,8 +558,8 @@ public class SpanLimitsConfig {
560558
### SdkMeterProvider
561559

562560
[SdkMeterProvider](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-metrics/latest/io/opentelemetry/sdk/metrics/SdkMeterProvider.html)
563-
is the SDK implementation of [MeterProvider](../api-components/#meterprovider),
564-
and is responsible for handling metric telemetry produced by the API.
561+
is the SDK implementation of [MeterProvider](../api/#meterprovider), and is
562+
responsible for handling metric telemetry produced by the API.
565563

566564
`SdkMeterProvider` is configured by the application owner, and consists of:
567565

@@ -929,9 +927,8 @@ public class ViewConfig {
929927
### SdkLoggerProvider
930928

931929
[SdkLoggerProvider](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-logs/latest/io/opentelemetry/sdk/logs/SdkLoggerProvider.html)
932-
is the SDK implementation of
933-
[LoggerProvider](../api-components/#loggerprovider), and is responsible for
934-
handling log telemetry produced by the log bridge API.
930+
is the SDK implementation of [LoggerProvider](../api/#loggerprovider), and is
931+
responsible for handling log telemetry produced by the log bridge API.
935932

936933
`SdkLoggerProvider` is configured by the application owner, and consists of:
937934

content/en/docs/languages/java/performance.md content/en/docs/zero-code/java/agent/performance.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: Performance
33
description: Performance reference for the OpenTelemetry Java agent
4-
weight: 75
4+
weight: 400
5+
aliases:
6+
- /docs/languages/java/performance/
57
cSpell:ignore: Dotel
68
---
79

@@ -40,7 +42,7 @@ the Java agent.
4042

4143
The volume of spans processed by the instrumentation might impact agent
4244
overhead. You can configure trace sampling to adjust the span volume and reduce
43-
resource usage. See [Sampling](../sdk/#sampler).
45+
resource usage. See [Sampling](/docs/languages/java/sdk/#sampler).
4446

4547
### Turn off specific instrumentations
4648

@@ -99,7 +101,7 @@ instrumentations, see
99101
When troubleshooting agent overhead issues, do the following:
100102

101103
- Check minimum requirements. See
102-
[Prerequisites](../getting-started/#prerequisites).
104+
[Prerequisites](/docs/languages/java/getting-started/#prerequisites).
103105
- Use the latest compatible version of the Java agent.
104106
- Use the latest compatible version of your JVM.
105107

static/refcache.json

+4
Original file line numberDiff line numberDiff line change
@@ -8859,6 +8859,10 @@
88598859
"StatusCode": 200,
88608860
"LastSeen": "2024-10-09T10:19:30.617798+02:00"
88618861
},
8862+
"https://javadoc.io/doc/io.opentelemetry": {
8863+
"StatusCode": 200,
8864+
"LastSeen": "2024-11-13T09:26:22.921349-05:00"
8865+
},
88628866
"https://javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-prometheus/latest": {
88638867
"StatusCode": 200,
88648868
"LastSeen": "2024-01-30T16:14:53.216459-05:00"

0 commit comments

Comments
 (0)