Skip to content

Commit 26c6c25

Browse files
jack-bergchalin
authored andcommitted
Merge java libraries into intrumentation ecosystem
1 parent 46158ea commit 26c6c25

File tree

5 files changed

+52
-222
lines changed

5 files changed

+52
-222
lines changed

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

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ aliases:
55
- /docs/java/manual_instrumentation
66
- manual
77
- manual_instrumentation
8+
- /docs/languages/java/libraries/
89
weight: 10
910
description: Instrumentation ecosystem in OpenTelemetry Java
1011
cSpell:ignore: Logback logback
@@ -63,8 +64,9 @@ Library instrumentation.
6364

6465
### Zero-code: Java agent
6566

66-
The Java agent is a form of zero-code instrumentation that dynamically
67-
manipulations application bytecode.
67+
The Java agent is a form of zero-code
68+
[automatic instrumentation](/docs/specs/otel/glossary/#automatic-instrumentation)
69+
that dynamically manipulations application bytecode.
6870

6971
For a list of libraries instrumented by the Java agent, see the
7072
"Auto-instrumented versions" column on
@@ -74,38 +76,41 @@ See [Java agent](/docs/zero-code/java/agent/) for more details.
7476

7577
### Zero-code: Spring Boot starter
7678

77-
The Spring Boot starter is a form of zero-code instrumentation that leverages
78-
spring autoconfigure to install
79+
The Spring Boot starter is a form of zero-code
80+
[automatic instrumentation](/docs/specs/otel/glossary/#automatic-instrumentation)
81+
that leverages spring autoconfigure to install
7982
[library instrumentation](#library-instrumentation).
8083

8184
See [Spring Boot starter](/docs/zero-code/java/spring-boot-starter/) for
8285
details.
8386

8487
### Library instrumentation
8588

86-
Library instrumentation wraps or uses extension points to instrument a library,
87-
requiring users to install and/or adapt library usage.
89+
[Library instrumentation](/docs/specs/otel/glossary/#instrumentation-library)
90+
wraps or uses extension points to instrument a library, requiring users to
91+
install and/or adapt library usage.
8892

8993
For a list of instrumentation libraries, see the "Standalone Library
9094
Instrumentation" column on
9195
[supported libraries](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md).
9296

9397
### Native instrumentation
9498

95-
Native instrumentation is built directly into libraries or frameworks.
96-
OpenTelemetry encourages library authors to add native instrumentation using the
97-
[API](../api-components/). In the long term, we hope the native instrumentation
98-
becomes the norm, and view the instrumentation maintained by OpenTelemetry in
99+
[Native instrumentation](/docs/specs/otel/glossary/#natively-instrumented) is
100+
built directly into libraries or frameworks. OpenTelemetry encourages library
101+
authors to add native instrumentation using the [API](../api-components/). In
102+
the long term, we hope the native instrumentation becomes the norm, and view the
103+
instrumentation maintained by OpenTelemetry in
99104
[opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
100105
as a temporary means of filling the gap.
101106

102-
For a list of libraries with native instrumentation, look for entries with the
103-
"native" badge in the [registry](/ecosystem/registry/?language=java).
107+
{{% docs/languages/native-libraries "java" %}}
104108

105109
### Manual instrumentation
106110

107-
Manual instrumentation is written by application authors, and typically specific
108-
to the application domain.
111+
[Manual instrumentation](/docs/specs/otel/glossary/#manual-instrumentation) is
112+
written by application authors, and typically specific to the application
113+
domain.
109114

110115
### Shims
111116

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

Lines changed: 0 additions & 187 deletions
This file was deleted.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- prettier-ignore -->
2+
{{ $howMany := .Get 1 | default 10 -}}
3+
{{ $langIndex := .Get 0 }}
4+
{{ $lang := index $.Site.Data.instrumentation $langIndex -}}
5+
{{ $integrations := where (slice ) ".language" $langIndex -}}
6+
7+
{{ $integrations := slice }} {{ range $entry := $.Site.Data.registry }}
8+
{{ if and (and (eq $entry.language $langIndex) (eq $entry.isNative true)) (eq $entry.registryType "instrumentation") }}
9+
{{ $integrations = $integrations | append $entry }} {{ end }} {{ end }}
10+
11+
{{ range first $howMany (sort $integrations "name") -}}
12+
13+
<!-- prettier-ignore -->
14+
- [{{ .title }}]({{ .urls.docs }})
15+
{{- end }}
16+
17+
{{ if eq (len $integrations) 0 -}}
18+
19+
<div class="alert alert-secondary" role="alert">
20+
<h4 class="alert-title">Help wanted!</h4>
21+
As of today, we don't know about any {{ $lang.name }} library that has OpenTelemetry
22+
natively integrated. If you know about such a library,
23+
<a href="https://github.com/open-telemetry/opentelemetry.io/issues/new" target="_blank" rel="noopener" class="external-link">let us know</a>.
24+
</div>
25+
{{ else -}}
26+
<div class="alert alert-info" role="alert">
27+
If you know a {{ $lang.name }} library that has OpenTelemetry
28+
natively integrated,
29+
<a href="https://github.com/open-telemetry/opentelemetry.io/issues/new" target="_blank" rel="noopener" class="external-link">let us know</a>.
30+
</div>
31+
{{ end -}}

layouts/shortcodes/docs/languages/libraries-intro.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,4 @@ OpenTelemetry SDK with your app.
3131
The library might require some additional configuration for the instrumentation.
3232
Go to the documentation for that library to learn more.
3333

34-
{{ range first $howMany (sort $integrations "name") -}}
35-
36-
<!-- prettier-ignore -->
37-
- [{{ .title }}]({{ .urls.docs }})
38-
{{- end }}
39-
40-
{{ if eq (len $integrations) 0 -}}
41-
42-
<div class="alert alert-secondary" role="alert">
43-
<h4 class="alert-title">Help wanted!</h4>
44-
As of today, we don't know about any {{ $lang.name }} library that has OpenTelemetry
45-
natively integrated. If you know about such a library,
46-
<a href="https://github.com/open-telemetry/opentelemetry.io/issues/new" target="_blank" rel="noopener" class="external-link">let us know</a>.
47-
</div>
48-
{{ else -}}
49-
<div class="alert alert-info" role="alert">
50-
If you know a {{ $lang.name }} library that has OpenTelemetry
51-
natively integrated,
52-
<a href="https://github.com/open-telemetry/opentelemetry.io/issues/new" target="_blank" rel="noopener" class="external-link">let us know</a>.
53-
</div>
54-
{{ end -}}
34+
{{ partial "docs/native-libraries.md" . }}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{ partial "docs/native-libraries.md" . }}

0 commit comments

Comments
 (0)