Skip to content
OpenTelemetry Java SDK
Java
Branch: master
Clone or download
carlosalberto Add tests for TraceShim/TracerShim. (#603)
* Add tests for TraceShim/TracerShim.

Although we have the extensive testbed section,
we need some basic tests for non-exotic scenarios,
and this is part of that intention.
Latest commit 0ff6da3 Oct 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Initial setup for publishing snapshots to OJO. (#523) Sep 13, 2019
all Move the InMemory artifact to exporters. (#600) Oct 11, 2019
api Move utils from API to SDK. (#613) Oct 15, 2019
buildscripts Replace everywhere OpenConsensus with OpenTelemetry (#244) May 2, 2019
contrib Cleanup and update dependencies. (#602) Oct 11, 2019
exporters Move Probability sampler to Samplers. (#616) Oct 15, 2019
gradle Initial setup for publishing snapshots to OJO. (#523) Sep 13, 2019
opentracing_shim Add tests for TraceShim/TracerShim. (#603) Oct 18, 2019
proto Remove unnecessary dependency in proto on API. (#581) Sep 30, 2019
sdk Move Probability sampler to Samplers. (#616) Oct 15, 2019
sdk_contrib Move the InMemory artifact to exporters. (#600) Oct 11, 2019
.gitignore Update gitignore and include TagMap[Builder]. Mar 28, 2019
.gitmodules Set proto submodule to upstream repository (#514) Aug 29, 2019
CODEOWNERS Updating according to the list in community repo (#363) May 31, 2019
CONTRIBUTING.md organize build directions in docs (#537) Sep 17, 2019
LICENSE Initial commit Feb 26, 2019
Makefile Initial setup for publishing snapshots to OJO. (#523) Sep 13, 2019
README.md Update README.md (#615) Oct 15, 2019
build.gradle Cleanup and update dependencies. (#602) Oct 11, 2019
gradlew Setup gradle, checkstyle, errorprone, google-java-format, jmh and fir… Feb 26, 2019
gradlew.bat Setup gradle, checkstyle, errorprone, google-java-format, jmh and fir… Feb 26, 2019
settings.gradle Restore gradle modules deleted when rebase (#610) Oct 11, 2019

README.md

OpenTelemetry

Gitter chat Build Status Coverage Status Maven Central

OpenTelemetry is a working name of a combined OpenCensus and OpenTracing project.

This project contains the following top level components:

  • api: The OpenTelemetry API.
    • trace: The tracing api. Includes Tracer, Span and SpanContext.
    • distributedcontext: Collection of entries in the form of key-value pairs of data that can be propagated to provide contextual information.
    • context: In-process and inter-process propagation layer.
    • metrics: Metrics layer.
  • sdk: The reference implementation complying to the OpenTelemetry API.
  • OpenTracing shim: A bridge layer from OpenTelemetry to the OpenTracing API.

We would love to hear from the larger community: please provide feedback proactively.

Project setup and contribute

Please refer to the contribution guide on how to setup and contribute!

Snapshots

Snapshots based out the master branch are available for opentelemetry-api, opentelemetry-sdk and the rest of the artifacts:

Maven

  <repositories>
    <repository>
      <id>oss.sonatype.org-snapshot</id>
      <url>https://oss.jfrog.org/artifactory/oss-snapshot-local</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-api</artifactId>
      <version>0.1.0-SNAPSHOT</version>
    </dependency>
  </dependencies>

Gradle

repositories {
	maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local' }
}

dependencies {
	compile('io.opentelemetry:opentelemetry-api:0.1.0-SNAPSHOT')
}

Libraries will usually only need opentelemetry-api, while applications may want to use opentelemetry-sdk.

Release Schedule

OpenTelemetry Java is under active development. Our goal is to release an alpha version of the library by middle October 2019. This release isn't guaranteed to conform to a specific version of the specification, and future releases will not attempt to maintain backwards compatibility with the alpha release.

Component Version Target Date
Tracing API Alpha October 21 2019
Tracing SDK Alpha October 21 2019
Metrics API Alpha October 21 2019
Metrics SDK Alpha October 21 2019
Jaeger Trace Exporter Alpha October 21 2019
Zipkin Trace Exporter Alpha Unknown
Prometheus Metrics Exporter Alpha Unknown
Context Propagation Alpha October 21 2019
OpenTracing Bridge Alpha October 21 2019
OpenCensus Bridge Alpha Unknown

Kick off the work towards 1.0

After beta release we will encourage customers and tracing vendors to start using the new project, providing feedback as they go. So we can ensure a high quality v1.0 for the merged project:

  • We will allow ourselves to break implementations, but not people using the public Interfaces.
  • Additions (into interfaces for instance) will involve a best-effort attempt at backwards compatibility (again, for implementations – callers of the public APIs should not be negatively affected by these additions).

Summary

We plan to merge projects and pave the path for future improvements as a unified community of tracing vendors, users and library authors who wants apps be managed better. We are open to feedback and suggestions from all of you!

You can’t perform that action at this time.