OpenTelemetry Java SDK
Go to file
John Watson ee435201b5
Immutable Attributes and Labels (#1304)
* prototype for class to replace Map<String, AttributeValue)

* safely copy the builder's data

* add the empty constant

* optimization for attributes with a single key/value

* Add an iterator/iterable and some simple tests

* fix animalsniffer complaint

* tests for de-duping and order-independent equality, plus removal of possibly unneeded access methods.

* clean up the sort&filter method a tad

* replace the iterator with a foreach method

* Make the Attributes parameterized by the value type.

* Add basic javadoc

* remove helper class; add a simple test for the builder; make the tests more robust

* Add a varargs method for creating an arbitrary number of key/value pairs.

* static import the check method, for consistency

* Refactor to have an interface and two implementations, with some shared logic.

* fix an accidental rename

* really fix it for real

* add a few more tests

* preserve the `setAttribute` names from existing Span API

* Replace the treemap sorting and filtering with a quicksort and post-filter.

* remove an unneeded list.

* switch to an abstract base class to remove some code duplication

* Updated docs based on feedback.

* Small change to use the builder for the empty implementations.
2020-06-08 17:16:39 -07:00
.circleci Provides a way to enable/disable the docker integration tests via a gradle property (#1115) 2020-04-16 15:12:30 -07:00
.github Proposal: Add @thisthat as an approval (#1223) 2020-05-15 16:43:30 +02:00
all First cut at a Zipkin Span Exporter (#1106) 2020-05-01 08:42:40 -07:00
api Immutable Attributes and Labels (#1304) 2020-06-08 17:16:39 -07:00
bom Small fix to publish bom artifact (#1282) 2020-05-29 07:56:53 -07:00
buildscripts Add .editorconfig file with google-java-format compatible options (#1136) 2020-04-27 08:42:59 -07:00
context_prop Apply intelij inspect suggestions for Java code (#1196) 2020-05-11 16:54:39 -07:00
contrib Remove duplicate Result interfaces (#1312) 2020-06-05 14:37:50 -07:00
examples Start 0.6.0 development cycle (#1306) 2020-06-04 08:31:53 -07:00
exporters Cleanup and additional tests for ConfigBuilder (#1296) 2020-06-02 11:33:21 -07:00
gradle/wrapper Update to use gradle 6.3 in all projects (#1103) 2020-04-11 16:27:37 -07:00
opentracing_shim Fix:spelling mistakes (#1294) 2020-05-31 15:49:32 -07:00
proto Apply bom imports only if needed (#1281) 2020-05-29 12:35:15 -07:00
sdk Remove duplicate Result interfaces (#1312) 2020-06-05 14:37:50 -07:00
sdk_contrib Directly fetch AWS resource metadata without depending on heavyweight… (#1289) 2020-06-01 11:32:44 -07:00
.codecov.yaml Require coverage 95% for api and sdk (#1252) 2020-05-20 11:40:45 -07:00
.editorconfig Add .editorconfig file with google-java-format compatible options (#1136) 2020-04-27 08:42:59 -07:00
.gitignore Add .editorconfig file with google-java-format compatible options (#1136) 2020-04-27 08:42:59 -07:00
.gitmodules Set proto submodule to upstream repository (#514) 2019-08-29 09:25:08 -07:00
CHANGELOG.md Update changelog to reflect released changes (#1183) 2020-05-07 08:12:31 -07:00
CONTRIBUTING.md Add .editorconfig file with google-java-format compatible options (#1136) 2020-04-27 08:42:59 -07:00
LICENSE Initial commit 2019-02-26 08:43:37 -08:00
Makefile Provides a way to enable/disable the docker integration tests via a gradle property (#1115) 2020-04-16 15:12:30 -07:00
QUICKSTART.md Rename [Batch|Simple]SpansProcessor to [Batch|Simple]SpanProcessor (#1241) 2020-05-18 10:02:50 -07:00
README.md Update owners in readme (#1226) 2020-05-15 09:22:16 -07:00
RELEASING.md Small fixes in the releasing instructions (#1049) 2020-03-29 19:45:22 +02:00
build.gradle Start 0.6.0 development cycle (#1306) 2020-06-04 08:31:53 -07:00
gradle.properties Provides a way to enable/disable the docker integration tests via a gradle property (#1115) 2020-04-16 15:12:30 -07:00
gradlew Upgrade to Gradle 6 enabling parallel build (#731) 2020-01-06 19:59:00 -05:00
gradlew.bat Update to use gradle 6.3 in all projects (#1103) 2020-04-11 16:27:37 -07:00
settings.gradle Update config / deps to allow building on Java 14. (#1287) 2020-05-29 08:55:38 -07:00

README.md

OpenTelemetry

Gitter chat Build Status Coverage Status Maven Central

We hold regular meetings. See details at community page.

Overview

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.
    • correlationcontext: 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!

Quick Start

Please refer to the quick start guide on how use the OpenTelemetry API.

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.4.0-SNAPSHOT</version>
    </dependency>
  </dependencies>

Gradle

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

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

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

Releases

OpenTelemetry Java is under active development. Releases aren't guaranteed to conform to a specific version of the specification. Future releases will not attempt to maintain backwards compatibility with previous releases.

The latest version of the libraries were released on March 27th, 2020. See the v0.3.0 alpha release.

This is a current feature status list:

Component Version
Tracing API v0.3.0
Tracing SDK v0.3.0
Metrics API v0.3.0
Metrics SDK v0.3.0
OTLP Exporter v0.3.0
Jaeger Trace Exporter v0.3.0
Zipkin Trace Exporter dev
Prometheus Metrics Exporter dev
Context Propagation v0.3.0
OpenTracing Bridge v0.3.0
OpenCensus Bridge N/A

See the project milestones for details on upcoming releases. The dates and features described in issues and milestones are estimates, and subject to change.

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!

Owners

Approvers (@open-telemetry/java-approvers):

Find more about the approver role in community repository.

Maintainers (@open-telemetry/java-maintainers):

Find more about the maintainer role in community repository.