Add outcome API

elastic · Aug 17, 2020 · c390771 · c390771
1 parent 32139bd
commit c390771
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/specs/agents/tracing-spans.md b/specs/agents/tracing-spans.md
@@ -17,6 +17,8 @@ the error rate of service B is 100% from service A's perspective.
 However, as service B doesn't receive any requests, the error rate is 0% from service B's perspective.
 The `span.outcome` also allows reasoning about error rates of external services.
 
+Agents should expose an API to manually override the outcome.
+This value must always take precedence over the automatically determined value.
 #### Span stack traces
 
 Spans may have an associated stack trace, in order to locate the associated source code that caused the span to occur. If there are many spans being collected this can cause a significant amount of overhead in the application, due to the capture, rendering, and transmission of potentially large stack traces. It is possible to limit the recording of span stack traces to only spans that are slower than a specified duration, using the config variable `ELASTIC_APM_SPAN_FRAMES_MIN_DURATION`.

diff --git a/specs/agents/tracing-transactions.md b/specs/agents/tracing-transactions.md
@@ -22,3 +22,6 @@ If an agent doesn't report the `outcome` (or reports `null`), the APM Server set
   For existing auto-instrumentations, agents should set the outcome either to `"failure"` or `"success"`.
 
 What counts as a failed or successful request depends on the protocol and does not depend on whether there are error documents associated with a transaction.
+
+Agents should expose an API to manually override the outcome.
+This value must always take precedence over the automatically determined value.