Skip to content

Commit

Permalink
[IA] Relocate Java Automatic pages to new Zero-code section (#4430)
Browse files Browse the repository at this point in the history
Co-authored-by: Phillip Carter <pcarter@fastmail.com>
Co-authored-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
Co-authored-by: Severin Neumann <neumanns@cisco.com>
  • Loading branch information
4 people committed May 23, 2024
1 parent baa017e commit 9eab7c5
Show file tree
Hide file tree
Showing 11 changed files with 70 additions and 17 deletions.
3 changes: 3 additions & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,6 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://wikipedia.org/wiki/(S.M.A.R.T|Hop_)
# TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
- ^https://shorturl.at/vLYZ0$
# FIXME(@chalin) drop this temporary rule
- ^/docs/languages/java/automatic
- ^\.\./automatic
2 changes: 1 addition & 1 deletion content/en/docs/concepts/distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ might be a good starting point.
There are language specific extensibility mechanisms to customize the
instrumentation libraries:

- [Java agent](../../languages/java/automatic/extensions)
- [Java agent](/docs/zero-code/java/agent/extensions)

## What you should know about distributions

Expand Down
25 changes: 25 additions & 0 deletions content/en/docs/zero-code/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Zero-code Instrumentation
weight: 2
cSpell:ignore: pageinfo
---

{{% pageinfo color="warning" %}}

🚧 The content of this section is under active development. To track progress,
see [Issue #4427]

[Issue #4427]: https://github.com/open-telemetry/opentelemetry.io/issues/4427

{{% /pageinfo %}}

OpenTelemetry [zero-code instrumentation][] is supported for the languages
listed below in the section index.

If you are using Kubernetes, you can use the [OpenTelemetry Operator for
Kubernetes][otel-op] to [inject zero-code instrumentation] for .NET, Java,
Node.js, Python, or Go into your application.

[inject zero-code instrumentation]: /docs/kubernetes/operator/automatic/
[zero-code instrumentation]: /docs/concepts/instrumentation/zero-code/
[otel-op]: /docs/kubernetes/operator/
17 changes: 17 additions & 0 deletions content/en/docs/zero-code/java/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Java zero-code instrumentation
linkTitle: Java
aliases:
- /docs/java/automatic_instrumentation
- /docs/languages/java/automatic_instrumentation
# FIXME: ensure version update script targets this file too
cascade:
vers:
instrumentation: 2.4.0
otel: 1.38.0
cSpell:ignore: Dotel myapp
---

Zero-code instrumentation with Java uses a Java agent JAR or Spring Boot
Starter. To learn how to manually instrument your service or app code, see
[Manual instrumentation](/docs/languages/java/instrumentation/).
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
title: Automatic Instrumentation
linkTitle: Automatic
title: Java Agent
linkTitle: Agent
aliases:
- /docs/java/automatic_instrumentation
- /docs/languages/java/automatic_instrumentation
redirects: [{ from: /docs/languages/java/automatic/*, to: ':splat' }]
cSpell:ignore: Dotel myapp
weight: 30
---

Automatic instrumentation with Java uses a Java agent JAR that can be attached
to any Java 8+ application. It dynamically injects bytecode to capture telemetry
from many popular libraries and frameworks. It can be used to capture telemetry
data at the "edges" of an app or service, such as inbound requests, outbound
HTTP calls, database calls, and so on. To learn how to manually instrument your
service or app code, see [Manual instrumentation](../instrumentation).
Zero-code instrumentation with Java uses a Java agent JAR attached to any Java
8+ application. It dynamically injects bytecode to capture telemetry from many
popular libraries and frameworks. It can be used to capture telemetry data at
the "edges" of an app or service, such as inbound requests, outbound HTTP calls,
database calls, and so on. To learn how to manually instrument your service or
app code, see [Manual instrumentation](/docs/languages/java/instrumentation/).

## Setup

Expand Down Expand Up @@ -89,14 +89,18 @@ and JVMs][support].

## Troubleshooting

{{% config_option name="otel.javaagent.debug" %}} Set to `true` to see debug
logs. Note that these are quite verbose. {{% /config_option %}}
{{% config_option name="otel.javaagent.debug" %}}

Set to `true` to see debug logs. Note that these are quite verbose.

{{% /config_option %}}

## Next steps

After you have automatic instrumentation configured for your app or service, you
might want to [annotate](annotations) selected methods or add
[manual instrumentation](../instrumentation) to collect custom telemetry data.
[manual instrumentation](/docs/languages/java/instrumentation/) to collect
custom telemetry data.

[opentelemetry-javaagent.jar]:
https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,6 @@ instrumented.
## Next steps

Beyond the use of annotations, the OpenTelemetry API allows you to obtain a
tracer that can be used for [Manual Instrumentation](../../instrumentation) and
execute code within the scope of that span.
tracer that can be used for
[Manual Instrumentation](/docs/languages/java/instrumentation/) and execute code
within the scope of that span.
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Spring Boot
linkTitle: Spring Boot
weight: 30
description: Spring Boot instrumentation for OpenTelemetry Java
aliases: [/docs/languages/java/automatic/spring-boot/]
# prettier-ignore
cSpell:ignore: autoconfigurations autoconfigures customizer datasource distro logback springboot webflux webmvc
---
Expand Down
4 changes: 4 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -4147,6 +4147,10 @@
"StatusCode": 200,
"LastSeen": "2024-01-30T16:15:47.00387-05:00"
},
"https://github.com/open-telemetry/opentelemetry.io/issues/4427": {
"StatusCode": 200,
"LastSeen": "2024-05-06T15:32:24.49099-04:00"
},
"https://github.com/open-telemetry/opentelemetry.io/issues/new": {
"StatusCode": 200,
"LastSeen": "2024-01-18T19:09:43.270324-05:00"
Expand Down

0 comments on commit 9eab7c5

Please sign in to comment.