io.opentracing.contrib:opentracing-elasticsearch-client

OpenTracing Instrumentation for Elasticsearch Client

License

License

Categories

Categories

CLI User Interface Search Business Logic Libraries Elasticsearch
GroupId

GroupId

io.opentracing.contrib
ArtifactId

ArtifactId

opentracing-elasticsearch-client
Last Version

Last Version

0.0.4
Release Date

Release Date

Type

Type

jar
Description

Description

io.opentracing.contrib:opentracing-elasticsearch-client
OpenTracing Instrumentation for Elasticsearch Client
Project URL

Project URL

https://github.com/opentracing-contrib/java-elasticsearch-client
Source Code Management

Source Code Management

http://github.com/opentracing-contrib/java-elasticsearch-client

Download opentracing-elasticsearch-client

How to add to project

<!-- https://jarcasting.com/artifacts/io.opentracing.contrib/opentracing-elasticsearch-client/ -->
<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-elasticsearch-client</artifactId>
    <version>0.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/io.opentracing.contrib/opentracing-elasticsearch-client/
implementation 'io.opentracing.contrib:opentracing-elasticsearch-client:0.0.4'
// https://jarcasting.com/artifacts/io.opentracing.contrib/opentracing-elasticsearch-client/
implementation ("io.opentracing.contrib:opentracing-elasticsearch-client:0.0.4")
'io.opentracing.contrib:opentracing-elasticsearch-client:jar:0.0.4'
<dependency org="io.opentracing.contrib" name="opentracing-elasticsearch-client" rev="0.0.4">
  <artifact name="opentracing-elasticsearch-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.opentracing.contrib', module='opentracing-elasticsearch-client', version='0.0.4')
)
libraryDependencies += "io.opentracing.contrib" % "opentracing-elasticsearch-client" % "0.0.4"
[io.opentracing.contrib/opentracing-elasticsearch-client "0.0.4"]

Dependencies

compile (2)

Group / Artifact Type Version
io.opentracing : opentracing-api jar 0.31.0
org.elasticsearch.client : transport jar 6.1.1

test (5)

Group / Artifact Type Version
org.apache.logging.log4j : log4j-api jar 2.8.2
org.apache.logging.log4j : log4j-core jar 2.8.2
io.opentracing : opentracing-util jar 0.31.0
io.opentracing : opentracing-mock jar 0.31.0
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

Build Status Coverage Status Released Version Apache-2.0 license

OpenTracing Elasticsearch Client Instrumentation

OpenTracing instrumentation for Elasticsearch clients.

Installation

Maven

pom.xml

Elasticsearch 5

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-elasticsearch5-client</artifactId>
    <version>VERSION</version>
</dependency>

Elasticsearch 6

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-elasticsearch6-client</artifactId>
    <version>VERSION</version>
</dependency>

Elasticsearch 7

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-elasticsearch7-client</artifactId>
    <version>VERSION</version>
</dependency>

Usage

// Instantiate tracer
Tracer tracer = ...

// Optionally register tracer with GlobalTracer
GlobalTracer.register(tracer);

// Build TransportClient with TracingPreBuiltTransportClient
TransportClient transportClient = new TracingPreBuiltTransportClient(settings)
                .addTransportAddress(...));

// Build RestClient adding TracingHttpClientConfigCallback
 RestClient restClient = RestClient.builder(
                new HttpHost(...))
                .setHttpClientConfigCallback(new TracingHttpClientConfigCallback(tracer))
                .build();

Custom Span Names with the TracingHttpClientConfigCallback

This driver includes support for customizing the spans created using the TracingHttpClientConfigCallback. You can use the predefined ones listed further below, or write your own in the form of a Function object.

// Create a Function for the TracingHttpClientConfigCallback that operates on
// the HttpRequest and returns a String that will be used as the Span name.
Function<HttpRequest, String> customSpanNameProvider =
  (request) -> request.getRequestLine().getMethod().toLowerCase();

// Build RestClient adding TracingHttpClientConfigCallback
 RestClient restClient = RestClient.builder(
                new HttpHost(...))
                .setHttpClientConfigCallback(new TracingHttpClientConfigCallback(tracer, customSpanNameProvider))
                .build();
 
 // Spans created by the restClient will now have the request's lowercase method name as the span name.
 // "POST" -> "post"

Predefined Span Name Providers

The following Functions are already included in the ClientSpanNameProvider class, with REQUEST_METHOD_NAME being the default should no other span name provider be provided.

  • REQUEST_METHOD_NAME: Returns the HTTP method of the request.
    • GET /twitter/tweet/1?routing=user1 -> "GET"
  • PREFIXED_REQUEST_METHOD_NAME(String prefix): Returns a String concatenation of prefix and the HTTP method of the request.
    • GET /twitter/tweet/1?routing=user1 -> prefix + "GET"
  • REQUEST_TARGET_NAME: Returns the Elasticsearch target of the request, i.e. the index and resource it's operating on. IDs and other numbers not part of names will be replaced with a "?" to avoid overly granular names.
    • GET /twitter/tweet/1?routing=user1 -> "/twitter/tweet/?"
  • PREFIXED_REQUEST_TARGET_NAME(String prefix): Returns a String concatenation of prefix and the Elasticsearch target of the request. IDs and other numbers not part of names will be replaced with a "?" to avoid overly granular names.
    • GET /twitter/tweet/1?routing=user1 -> prefix + "/twitter/tweet/?"
  • REQUEST_METHOD_TARGET_NAME: Returns a String concatenation of the HTTP method of the request and the Elasticsearch target of the request. IDs and other numbers not part of names will be replaced with a "?" to avoid overly granular names.
    • GET /twitter/tweet/1?routing=user1 -> "GET /twitter/tweet/?"
  • PREFIXED_REQUEST_METHOD_TARGET_NAME(String prefix): Returns a String concatenation of prefix, the HTTP method of the request, and the Elasticsearch target of the request. IDs and other numbers not part of names will be replaced with a "?" to avoid overly granular names.
    • GET /twitter/tweet/1?routing=user1 -> prefix + "GET /twitter/tweet/?"

License

Apache 2.0 License.

io.opentracing.contrib

3rd-Party OpenTracing API Contributions

3rd-party contributions that use OpenTracing. **The repositories in this org are *not* affiliated with the CNCF.**

Versions

Version
0.0.4
0.0.3
0.0.2
0.0.1