Refactor public constructor API (jaegertracing#346)

* Refactor public builder API Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Revert stats Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Fix Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Increase test coverage Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Increase test coverage samplingmanager Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Increase coverage 4 Signed-off-by: Pavol Loffay <ploffay@redhat.com> * fix Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Increate coverage tracer Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Increate coverage tracer 2 Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Remove lombook getter Signed-off-by: Pavol Loffay <ploffay@redhat.com> * Wrap tracer tags into new hashmap Signed-off-by: Pavol Loffay <ploffay@redhat.com>
jpkrohling · Feb 26, 2018 · 581e20f · 581e20f
1 parent e152db4
commit 581e20f
Show file tree

Hide file tree

Showing 15 changed files with 652 additions and 184 deletions.
diff --git a/jaeger-core/README.md b/jaeger-core/README.md
@@ -14,10 +14,23 @@ This module provides core tracing functionality for custom instrumentation.
 
 ### Production
 
-For production usage, it is recommended to use `com.uber.jaeger.Configuration` with default parameters:
+Tracer can be created via `com.uber.jaeger.Tracer.Builder` or `com.uber.jaeger.Configuration`.
+For production it is recommended to use both classes with default values.
+
+`Tracer.Builder` example:
+
+```java
+Tracer tracer = new Tracer.Builder("myServiceName")
+  .build()
+```
+
+`Configuration` holds only primitive values and it is designed to be used with configuration
+files or when configuration is provided in environmental variables.
 
 ```java
-Configuration config = new Configuration("myServiceName", null, null);
+Configuration config = new Configuration("myServiceName")
+  .withReporter(...); // optional if you want to get metrics about tracer behavior
+
 Tracer tracer = config.getTracer();
 ```