https://github.com/opentracing-contrib/java-elasticsearch-client
OpenTracing Instrumentation for Elasticsearch Client
https://github.com/opentracing-contrib/java-elasticsearch-client
elasticsearch-client java opentracing
Last synced: 4 months ago
JSON representation
OpenTracing Instrumentation for Elasticsearch Client
- Host: GitHub
- URL: https://github.com/opentracing-contrib/java-elasticsearch-client
- Owner: opentracing-contrib
- License: apache-2.0
- Created: 2017-04-15T21:05:00.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T16:30:57.000Z (over 4 years ago)
- Last Synced: 2026-01-21T22:32:37.461Z (6 months ago)
- Topics: elasticsearch-client, java, opentracing
- Language: Java
- Homepage:
- Size: 171 KB
- Stars: 8
- Watchers: 0
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Released Version][maven-img]][maven] [](https://opensource.org/licenses/Apache-2.0)
# OpenTracing Elasticsearch Client Instrumentation
OpenTracing instrumentation for Elasticsearch clients.
## Installation
### Maven
pom.xml
#### Elasticsearch 5
```xml
io.opentracing.contrib
opentracing-elasticsearch5-client
VERSION
```
#### Elasticsearch 6
```xml
io.opentracing.contrib
opentracing-elasticsearch6-client
VERSION
```
#### Elasticsearch 7
```xml
io.opentracing.contrib
opentracing-elasticsearch7-client
VERSION
```
## Usage
```java
// 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.
```java
// Create a Function for the TracingHttpClientConfigCallback that operates on
// the HttpRequest and returns a String that will be used as the Span name.
Function 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](./LICENSE).
[ci-img]: https://travis-ci.org/opentracing-contrib/java-elasticsearch-client.svg?branch=master
[ci]: https://travis-ci.org/opentracing-contrib/java-elasticsearch-client
[cov-img]: https://coveralls.io/repos/github/opentracing-contrib/java-elasticsearch-client/badge.svg?branch=master
[cov]: https://coveralls.io/github/opentracing-contrib/java-elasticsearch-client?branch=master
[maven-img]: https://img.shields.io/maven-central/v/io.opentracing.contrib/opentracing-elasticsearch6-client.svg
[maven]: http://search.maven.org/#search%7Cga%7C1%7Copentracing-elasticsearch6-client