apm-agent-nodejs icon indicating copy to clipboard operation
apm-agent-nodejs copied to clipboard

document that transactions with `unknown` outcomes are ignored in the error rate calculation

Open trentm opened this issue 3 years ago • 0 comments

https://github.com/elastic/apm/blob/main/specs/agents/tracing-transactions.md#outcome-api says:

The documentation [for the Outcome API] should clarify that transactions with unknown outcomes are ignored in the error rate calculation.

There are two places this is relevant in our docs:

  1. our transaction.setOutcome() api docs
  2. (once the OTel Bridge PR is in) in the OTel Bridge docs somewhere, in reference to creating an OTel span without calling span.setStatus(). The default OTel Span status is UNSET, which translates to .outcome = 'unknown'. To have local-root OTel spans (i.e. those that are translated to Elastic Transactions) be included in error rate calculations in the APM UI, the user should be setting a status on them.

trentm avatar May 11 '22 21:05 trentm