Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lightstep/lightstep-tracer-java

The Lightstep distributed tracing library for JRE
https://github.com/lightstep/lightstep-tracer-java

opentracing

Last synced: 8 days ago
JSON representation

The Lightstep distributed tracing library for JRE

Host: GitHub
URL: https://github.com/lightstep/lightstep-tracer-java
Owner: lightstep
License: mit
Created: 2016-04-22T23:13:55.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2023-10-06T01:24:42.000Z (about 1 year ago)
Last Synced: 2023-11-05T13:09:44.267Z (about 1 year ago)
Topics: opentracing
Language: Java
Homepage: https://lightstep.com
Size: 39.1 MB
Stars: 46
Watchers: 64
Forks: 25
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # lightstep-tracer-java [Deprecated]

[ ![Download](https://maven-badges.herokuapp.com/maven-central/com.lightstep.tracer/lightstep-tracer-java/badge.svg) ](https://maven-badges.herokuapp.com/maven-central/com.lightstep.tracer/lightstep-tracer-java) [![Circle CI](https://circleci.com/gh/lightstep/lightstep-tracer-java.svg?style=shield)](https://circleci.com/gh/lightstep/lightstep-tracer-java) [![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)

In August 2023, [Lightstep became ServiceNow

Cloud Observability](https://docs.lightstep.com/docs/banner-faq). To ease the

transition, all code artifacts will continue to use the Lightstep name. You

don't need to do anything to keep using this repository.

The LightStep distributed tracing library for the standard Java runtime environment.

* [Getting Started](#getting-started)

  * [JRE](#getting-started-jre)

* [API documentation](#apidocs)

* [Options](#options)





## Getting started: JRE

The JRE library is hosted on  Maven Central. 

**Note**: Starting from version 0.30.0, lightstep-tracer-java-common and lightstep-tracer-java artifacts use the same

major/minor version, only differing in the patch part.

### Maven

```xml

    com.lightstep.tracer

    lightstep-tracer-jre

     VERSION 

   com.lightstep.tracer

   tracer-okhttp

    VERSION 

    org.slf4j

    slf4j-simple

    1.7.25

```

* Be sure to replace `VERSION` with the current version of the library. For `TRACER-GRPC-VERSION` you can refer to  [lightstep-tracer-common](https://github.com/lightstep/lightstep-tracer-java-common) which contains `tracer-grpc` (and `tracer-okhttp`).

* LightStep libraries use provided scope for grpc-netty, netty-tcnative-boringssl-static and slf4j. In other words, LightStep tracer libraries will rely on whichever gRPC/Netty/sl4j version is currently available (i.e. pulled in at runtime) to avoid conflicting with existing versions within your project

### Gradle

In most cases, modifying your `build.gradle` with the below is all that is required:

```

repositories {

    mavenCentral() // OR jcenter()

}

dependencies {

    compile 'com.lightstep.tracer:lightstep-tracer-jre:VERSION'

    compile 'com.lightstep.tracer:tracer-okhttp:VERSION'

    compile 'org.slf4j:slf4j-simple:1.7.25'

}

```

* Be sure to replace `VERSION` with the current version of the library

* The artifact is published to both `jcenter()` and `mavenCentral()`. Use whichever you prefer.

### Initializing the LightStep Tracer

```java

// Important the OpenTracing interfaces

import io.opentracing.Span;

import io.opentracing.Tracer;

// ...

// Initialize the OpenTracing Tracer with LightStep's implementation

Tracer tracer = new com.lightstep.tracer.jre.JRETracer(

         new com.lightstep.tracer.shared.Options.OptionsBuilder()

            .withAccessToken("{your_access_token}")

            .build()

);

// Start and finish a Span

Span span = tracer.buildSpan("my_span").start();

this.doSomeWorkHere();

span.finish();

```



## API Documentation

Tracing instrumentation should use the OpenTracing APIs to stay portable and in sync with the standard:

* [OpenTracing API (javadoc)](http://javadoc.io/doc/io.opentracing/opentracing-api)

For reference, the generated LightStep documentation is also available:

* [lightstep-tracer-jre (javadoc)](http://javadoc.io/doc/com.lightstep.tracer/lightstep-tracer-jre)

## Options

### Setting a custom component name

To set the name used in the LightStep UI for this instance of the Tracer, call `withComponentName()` on the `OptionsBuilder` object:

```java

options = new com.lightstep.tracer.shared.Options.OptionsBuilder()

                      .withAccessToken("{your_access_token}")

                      .withComponentName("your_custom_name")

                      .build();

```

### Disabling the reporting loop

By default, the Java library does a report of any buffered data on a fairly regular interval. To disable this behavior and rely only on explicit calls to `flush()` to report data, initialize with:

```java

options = new com.lightstep.tracer.shared.Options.OptionsBuilder()

                      .withAccessToken("{your_access_token}")

                      .withDisableReportingLoop(true)

                      .build();

```

To then manually flush by using the LightStep tracer object directly:

```java

// Flush any buffered tracing data

((com.lightstep.tracer.jre.JRETracer)tracer).flush();

```

### Flushing the report at exit

In order to send a final flush of the data prior to exit, clients should manually flush by using the LightStep tracer object as described above.

### Disabling default clock correction

By default, the Java library performs clock correction based on timestamp information provided in the spans. To disable this behavior, initialize with: 

```java

options = new com.lightstep.tracer.shared.Options.OptionsBuilder()

                      .withAccessToken("{your_access_token}")

                      .withClockSkewCorrection(false)

                      .build();

```

### Advanced Option: Transport and Serialization Protocols

By following the above configuration, the tracer will send information to LightStep using HTTP and Protocol Buffers which is the recommended configuration. If there are no specific transport protocol needs you have, there is no need to change this default.

There are two options for transport protocols:

- [Protocol Buffers](https://developers.google.com/protocol-buffers/) over HTTP using [OkHttp](http://square.github.io/okhttp/) - The recommended and default solution.

- [Protocol Buffers](https://developers.google.com/protocol-buffers/) over [GRPC](https://grpc.io/) - This is a more advanced solution that might be desirable if you already have gRPC networking configured.

You can configure the tracer to support gRPC by replacing `com.lightstep.tracer:tracer-okhttp` with `com.lightstep.tracer:tracer-grpc` when including the tracer dependency and including a grpc dependency. i.e.

#### Maven 

```xml

  com.lightstep.tracer

  lightstep-tracer-jre

   VERSION 

   com.lightstep.tracer

   tracer-grpc

    VERSION 

    io.grpc

    grpc-netty

    1.23.0

    io.netty

    netty-tcnative-boringssl-static

    2.0.25.Final

```

#### Gradle

```

repositories {

    mavenCentral() // OR jcenter()

}

dependencies {

    compile 'com.lightstep.tracer:lightstep-tracer-jre:VERSION'

    compile 'com.lightstep.tracer:tracer-grpc:VERSION'

    compile 'io.grpc:grpc-netty:1.23.0'

    compile 'io.netty:netty-tcnative-boringssl-static:2.0.25.Final'

}

```

## Development info

See [DEV.md](DEV.md) for information on contributing to this instrumentation library.