Skip to content

Improving documentation - stop using "incubating" and explain the expectations #876

@fstendel

Description

@fstendel

Is your feature request related to a problem? Please describe.
JMS instrumentation of ElasticAPM Java agent is marked as "in incubating" since version 1.7.0,
leaving developers with a lot of uncertainty in regards to production readiness.
Additionally, - even when uncertainty is put aside - this instrumentation is activated by "not deactivating any other instrumentation" leading to situations where one could not use the "incubating" JMS-instrumentation, e.g. when another instrumentation needs to be deactivated.

Describe the solution you'd like

  • Clarification in the documentation about what incubating means.
  • Ideally an ETA when feature leaves this state.
  • Separate configuration key to explicitly activate incubating features (e.g. enable_incubating_features=jms). A sensible default behavior in regards to incubating state change would be to ignore this particular entry when features leave incubating and print out a warn-message in the logs.

Describe alternatives you've considered
The alternative considered and currently in-place is to implement some sort of decorator-class which resembles the behavior of the JMS-instrumentation in question (e.g. decorator for MessageListener).
As this decorator only resembles the behavior of the ElasticAPM-instrumentation, both the incubating instrumentation and the homegrown solution might diverge from a UI-users perspective.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions