Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smoketurner/dropwizard-zipkin
Dropwizard Zipkin Bundle
https://github.com/smoketurner/dropwizard-zipkin
distributed-tracing dropwizard dropwizard-zipkin instrumentation java tracing zipkin zipkin-brave
Last synced: about 2 months ago
JSON representation
Dropwizard Zipkin Bundle
- Host: GitHub
- URL: https://github.com/smoketurner/dropwizard-zipkin
- Owner: smoketurner
- License: apache-2.0
- Archived: true
- Created: 2016-02-07T22:19:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T01:56:36.000Z (almost 2 years ago)
- Last Synced: 2024-06-21T18:09:19.220Z (7 months ago)
- Topics: distributed-tracing, dropwizard, dropwizard-zipkin, instrumentation, java, tracing, zipkin, zipkin-brave
- Language: Java
- Homepage:
- Size: 3.18 MB
- Stars: 50
- Watchers: 7
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-dropwizard - dropwizard-zipkin - A Zipkin bundle for Dropwizard (Open Source / Eclipse)
README
Dropwizard Zipkin Bundle
========================
[](https://travis-ci.org/smoketurner/dropwizard-zipkin)
[](https://maven-badges.herokuapp.com/maven-central/com.smoketurner.dropwizard/dropwizard-zipkin/)
[](https://github.com/smoketurner/dropwizard-zipkin/tree/master)
[](https://www.patreon.com/bePatron?u=9567343)
A bundle for submitting tracing data to [Zipkin](http://zipkin.io) from Dropwizard applications. Internally, this library uses [Brave](https://github.com/openzipkin/brave) to interface a Zipkin collector.
Dependency Info
---------------
```xml
com.smoketurner.dropwizard
zipkin-core
2.0.7-1
```
Beginning with v1.2.2-4, if you are using the Kafka sender, you must explicitly add the `kafka-clients` dependency into your `pom.xml` as it has been excluded from the `zipkin-core` module.
```xml
org.apache.kafka
kafka-clients
2.2.1
```
Usage
-----
Add a `ZipkinBundle` to your [Application](https://javadoc.io/doc/io.dropwizard/dropwizard-project/latest/io/dropwizard/Application.html) class.
```java
private ZipkinBundle zipkinBundle;
@Override
public void initialize(Bootstrap bootstrap) {
zipkinBundle = new ZipkinBundle(getName()) {
@Override
public ZipkinFactory getZipkinFactory(HelloWorldConfiguration configuration) {
return configuration.getZipkinFactory();
}
};
bootstrap.addBundle(zipkinBundle);
}
@Override
public void run(HelloWorldConfiguration configuration, Environment environment) throws Exception {
final Optional tracing = zipkinBundle.getHttpTracing();
}
```
Configuration
-------------
For configuring the Zipkin connection, there is a `ZipkinFactory`:
```yaml
zipkin:
# Required properties
# Whether tracing is enabled or not (defaults to true)
enabled: true
# Listening IP address of the service
serviceHost: 192.168.1.100
# Listening port of the service
servicePort: 8080
# Optional properties
# Span collector to use (console, http, kafka or empty)
collector: http
# If using the http collector, provide the baseUrl
baseUrl: http://127.0.0.1:9411/
# If using the http collector, timeout out when connecting (defaults to 10s)
connectTimeout: 10s
# If using the http collector, timeout out when reading the response (defaults to 60s)
readTimeout: 60s
# If using the kafka collector, provide the Kafka bootstrap servers
bootstrapServers: 127.0.0.1:9092;10.0.1.1:9092
```
Example Application
-------------------
This bundle includes a modified version of the `HelloWorldApplication` from Dropwizard's [Getting Started](https://www.dropwizard.io/en/latest/getting-started.html) documentation.
You can execute this application by first starting Zipkin on your local machine then running:
```
./mvnw clean package
java -jar zipkin-example/target/zipkin-example-*-SNAPSHOT.jar server zipkin-example/hello-world.yml
```
This will start the application on port `8080` (admin port `8180`). This application demonstrations the following Zipkin integration points:
- You can use the included `ZipkinClientBuilder` to construct an instrumented `JerseyClient`'s that will send span traces to Zipkin
- The service will send request and response traces to Zipkin
Support
-------
Please file bug reports and feature requests in [GitHub issues](https://github.com/smoketurner/dropwizard-zipkin/issues).
License
-------
Copyright (c) 2020 Smoke Turner, LLC
This library is licensed under the Apache License, Version 2.0.
See http://www.apache.org/licenses/LICENSE-2.0.html or the [LICENSE](LICENSE) file in this repository for the full license text.