-
Notifications
You must be signed in to change notification settings - Fork 848
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add opentelemetry.io docs #3070
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
--- | ||
title: "Java" | ||
weight: 18 | ||
description: > | ||
<img width="35" src="https://raw.github.com/open-telemetry/opentelemetry.io/main/iconography/32x32/Java_SDK.svg"></img> | ||
A language-specific implementation of OpenTelemetry in Java. | ||
--- | ||
|
||
**Note**: As of 3/29 this is a copy of the documentation live on opentelemetry.io, and requires updates to become current with the current Java release. | ||
|
||
OpenTelemetry Java consists of the following repositories: | ||
|
||
- [opentelemetry-java](https://github.com/open-telemetry/opentelemetry-java): | ||
Components for manual instrumentation including API and SDK as well as | ||
extensions, the OpenTracing shim and examples. | ||
- [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation): | ||
Built on top of opentelemetry-java and provides a Java agent JAR that can be | ||
attached to any Java 8+ application and dynamically injects bytecode to | ||
capture telemetry from a number of popular libraries and frameworks. | ||
- [opentelemetry-java-contrib](https://github.com/open-telemetry/opentelemetry-java-contrib): | ||
Provides helpful libraries and standalone OpenTelemetry-based utilities that | ||
don't fit the express scope of the OpenTelemetry Java or Java Instrumentation | ||
projects. For example, JMX metric gathering. | ||
|
||
## opentelemetry-java | ||
|
||
| Traces | Metrics | Logs | | ||
| ------ | ------- | ------------ | | ||
| Beta | Alpha | Experimental | | ||
|
||
### Components | ||
|
||
- Tracing API | ||
- Tracing SDK | ||
- Metrics API | ||
- Metrics SDK | ||
- OTLP Exporter | ||
- Jaeger Trace Exporter | ||
- Zipkin Trace Exporter | ||
- Prometheus Metric Exporter | ||
- Context Propagation | ||
- OpenTracing Bridge | ||
- OpenCensus Bridge | ||
|
||
### Releases | ||
|
||
Published releases are available on maven central. | ||
|
||
#### Maven | ||
|
||
```xml | ||
<dependencies> | ||
<dependency> | ||
<groupId>io.opentelemetry</groupId> | ||
<artifactId>opentelemetry-api</artifactId> | ||
<version>0.10.0</version> | ||
</dependency> | ||
</dependencies> | ||
``` | ||
|
||
#### Gradle | ||
|
||
```groovy | ||
dependencies { | ||
implementation('io.opentelemetry:opentelemetry-api:0.10.0') | ||
} | ||
``` | ||
|
||
#### Other | ||
|
||
- [releases](https://github.com/open-telemetry/opentelemetry-java/releases) | ||
- [maven](https://mvnrepository.com/artifact/io.opentelemetry) | ||
- [bintray](https://bintray.com/open-telemetry/maven/opentelemetry-java) | ||
|
||
### Additional Information | ||
|
||
- [Javadoc](https://www.javadoc.io/doc/io.opentelemetry) | ||
- [Example code](https://github.com/open-telemetry/opentelemetry-java/tree/main/examples) | ||
|
||
## opentelemetry-java-instrumentation | ||
|
||
| Traces | Metrics | Logs | | ||
| ------ | ------- | ------------ | | ||
| Beta | Alpha | Experimental | | ||
|
||
### Releases | ||
|
||
> Published releases are *NOT* available on maven central, but will be by GA. | ||
|
||
- [releases](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases) | ||
- [bintray](https://bintray.com/open-telemetry/maven/opentelemetry-java-instrumentation) | ||
|
||
> Snapshots are also available as documented | ||
> [here](https://github.com/open-telemetry/opentelemetry-java/blob/main/CONTRIBUTING.md#snapshots). | ||
|
||
### Additional Information | ||
|
||
- [Javadoc](https://www.javadoc.io/doc/io.opentelemetry) | ||
- [Example code](https://github.com/open-telemetry/opentelemetry-java/tree/main/examples) | ||
|
||
## opentelemetry-java-contrib | ||
|
||
| Component | Status | | ||
| ----------------- | ------ | | ||
| JMX Metric Gather | Alpha | | ||
|
||
### Releases | ||
|
||
- [releases](https://github.com/open-telemetry/opentelemetry-java-contrib/releases) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.