Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/expediadotcom/haystack-opentelemetry-example
https://github.com/expediadotcom/haystack-opentelemetry-example
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/expediadotcom/haystack-opentelemetry-example
- Owner: ExpediaDotCom
- License: apache-2.0
- Created: 2020-05-18T18:19:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T21:44:39.000Z (over 2 years ago)
- Last Synced: 2023-02-27T00:32:43.556Z (over 1 year ago)
- Language: Java
- Size: 79.1 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Haystack OpenTelemetry through Zipkin
[](https://travis-ci.org/ExpediaDotCom/haystack-opentelemetry-example)
[](https://github.com/ExpediaDotCom/haystack/blob/master/LICENSE)
[OpenTelemetry] provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
Haystack can consume spans generated from [OpenTelemetry] by using its ZipkinSpanExporter. It currently supports languages such as:
- [Java]
- [Node.js]
- [Python]
among others.
## How to integrate with Haystack
[Haystack Agent] is capable of consuming Zipkin spans through its [Pitchfork] endpoint. In order to enable this, it needs to be enabled in the configurations files like this:
```
agents {
spans {
...
}
ossblobs {
...
}
pitchfork {
enabled = true
port = 9411
http.threads {
max = 16
min = 2
}
gzip.enabled = true
idle.timeout.ms = 60000
stop.timeout.ms = 30000
accept.null.timestamps = false
max.timestamp.drift.sec = -1
dispatchers {
kafka {
bootstrap.servers = ":19092"
producer.topic = "proto-spans"
buffer.memory = 1048576
retries = 2
}
}
}
}
```
After this, when agent is initialized it'll listen on http://localhost:9411/api/v1/spans for zipkin spans. Please refer to Haystack Agent documentation for [Pitchfork] endpoint versions.
## Java ZipkinSpanExporter
This example will show how to export [OpenTelemetry] spans to haystack through [ZipkinSpanExporter]
### Dependencies
Add the appropriate [OpenTelemetry] and Zipkin dependencies:
```
io.opentelemetry
opentelemetry-api
LIBRARY_VERSION
io.opentelemetry
opentelemetry-exporters-zipkin
LIBRARY_VERSION
io.zipkin.zipkin2
zipkin
LIBRARY_VERSION
```
### Code Configuration
In the provided example, a configuration object with the endpoint and service name information is created:
```
ZipkinExporterConfiguration configuration =
ZipkinExporterConfiguration
.builder()
.setEndpoint()
.setServiceName()
.setEncoder(SpanBytesEncoder.JSON_V2) // JSON_V1, PROTO3 or THRIFT
.build();
```
After creating the configuration object, a ZipkinSpanExporter is created, this will be the object
that will actually send our spans:
```
ZipkinSpanExporter exporter = ZipkinSpanExporter.create(configuration);
```
Once the exporter object is set up, the spans are created by using the SpanData class
which zipkin consumes:
```
SpanData spandata = SpanData.newBuilder()
.setTraceId(...)
.setName(...)
.setSpanId(...)
.setStartEpochNanos(...)
.setEndEpochNanos(...)
.setHasEnded(...)
.setHasRemoteParent(...)
.setKind(...)
.setStatus(...)
.setAttributes(...)
.setTotalAttributeCount(...)
.build();
```
After the span(s) are created, the method export from the previously created exporter is used to send the spans:
```
exporter.export(Arrays.asList(spandata));
```
Since this has configured the Haystack [Pitchfork] endpoint it'll send the spans there for
consumption. [Haystack Agent] understands Zipkin spans and parses them into our own spans and
process them into our pipeline.
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
[Java]: https://github.com/open-telemetry/opentelemetry-java/blob/d7f6d5a64176b44752bbd4bd403716a0f150b3e6/exporters/zipkin/src/main/java/io/opentelemetry/exporters/zipkin/ZipkinSpanExporter.java
[Node.js]:https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-exporter-zipkin
[Python]:https://opentelemetry-python.readthedocs.io/en/latest/ext/zipkin/zipkin.html
[OpenTelemetry]: https://opentelemetry.io/
[Pitchfork]: https://github.com/ExpediaDotCom/haystack-agent#zipkin-agent-pitchfork
[Haystack Agent]: https://github.com/ExpediaDotCom/haystack-agent