Improvements in the OT Bridge docs
@@ -22,22 +22,33 @@ subsequent spans are mapped to Elastic APM
This bridge allows for different operation modes in combination with the Elastic APM `javaagent`
-- Noop +
+Noop::
++
+--
If the `javaagent` is not specified, the bridge is in noop mode and does not actually record and report spans.
-- Mix and Match +
+--
+
+Mix and Match::
++
+--
If you want to leverage the auto instrumentation of Elastic APM,
but also want do create custom spans or use the OpenTracing API to add custom tags to the spans created by Elastic APM,
you can just do that.
The OpenTracing bridge and the standard Elastic APM API interact seamlessly.
-- Manual instrumentation +
+--
+
+Manual instrumentation::
++
+--
If you don't want Elastic APM to auto-instrument known frameworks,
but instead only rely on manual instrumentation,
disable the auto instrumentation setting the configuration option <<config-instrument,`instrument`>> to `false`.
+--
[float]
[[getting-started]]
=== Getting started
-The first step in getting started with the OpenTracing API bridge ist to declare a dependency to the API:
+The first step in getting started with the OpenTracing API bridge is to declare a dependency to the API:
[source,xml]
.pom.xml
@@ -80,7 +91,7 @@ Tracer tracer = new ElasticApmTracer();
Elastic APM defines some tags which are not included in the OpenTracing API but are relevant in the context of Elastic APM.
-- `type` - sets the type of the transaction,
+- `type` - sets the type of the transaction/span,
for example `request`, `ext` or `db`
- `user.id` - sets the user id,
appears in the "User" tab in the transaction details in the Elastic APM UI
@@ -90,6 +101,7 @@ Elastic APM defines some tags which are not included in the OpenTracing API but
appears in the "User" tab in the transaction details in the Elastic APM UI
- `result` - sets the result of the transaction. Overrides the default value of `success`.
If the `error` tag is set to `true`, the default value is `error`.
+ Setting `http.status_code` to `200`, for example, implicitly sets the result to `HTTP 2xx` if not explicitly set otherwise.
[float]
[[unsupported]]
@@ -134,3 +146,4 @@ span.log(
)
----
+Other logs are silently dropped.
