Skip to content
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.

Sign up for GitHub

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

update the website docs to be current #3081

Merged
merged 2 commits into from
Mar 31, 2021
Merged

update the website docs to be current #3081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21dce95
update the website docs to be current
Mar 30, 2021
eb8728b
Update website_docs/_index.md
jkwatson Mar 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 18 additions & 38 deletions website_docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ description: >
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):
Expand All @@ -26,7 +24,7 @@ OpenTelemetry Java consists of the following repositories:

| Traces | Metrics | Logs |
| ------ | ------- | ------------ |
| Beta | Alpha | Experimental |
| Stable | Alpha | Experimental |

### Components

Expand All @@ -44,66 +42,48 @@ OpenTelemetry Java consists of the following repositories:

### Releases

Published releases are available on maven central.
Published releases are available on maven central. We strongly recommend using our BOM to keep the
versions of the various components in sync.

#### Maven

```xml
<project>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-bom</artifactId>
<version>1.0.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>io.opentelemetry</groupId>
<artifactId>opentelemetry-api</artifactId>
<version>0.10.0</version>
</dependency>
</dependencies>
</project>
```

#### Gradle

```groovy
dependencies {
implementation('io.opentelemetry:opentelemetry-api:0.10.0')
implementation platform("io.opentelemetry:opentelemetry-bom:1.0.1")
implementation('io.opentelemetry:opentelemetry-api')
}
```

#### 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)
Loading