Promote some features to GA (#2653)

SylvainJuge · web-flow · commit 3d284af3db0c · 2022-06-08T10:43:25.000+02:00
* document attach API as GA

* make cli attach GA

* make dubbo plugin GA

* promote use_path_as_transaction_name to GA

* promote JDK http server to GA

* GA in supp. tech. for dubbo + circuit breaker

* make OTel bridge as GA

* update changelog

* improve changelog
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
@@ -30,6 +30,13 @@ the agent will now include the database name in the dependency, thus `mysql/my-d
 
 [float]
 ===== Features
+* Promote mature agent features as Generaly Available (GA) - {pull}2632[#2632]
+** <<opentelemetry-bridge,OpenTelemetry bridge>> is now enabled by default
+** <<config-circuit-breaker,Circuit breaker>> marked as GA (still disabled by default)
+** <<setup-attach-api,API Attach>> and <<setup-attach-cli,CLI Attach>> marked as GA
+** <<config-use-path-as-transaction-name,`use_path_as_transaction_name`>> configuration option marked as GA
+** Dubbo instrumentation is now enabled by default
+** `com.sun.net.httpserver.HttpServer` instrumentation marked as GA
 * Struts action invocations via an action chain result start a new span - {pull}2513[#2513]
 * Added official support for Elasticsearch Java API client - {pull}2211[#2211]
 * Added the ability to make spans non-discardable through the public API and the OpenTelemetry bridge - {pull}2632[#2632]
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/circuitbreaker/CircuitBreakerConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/circuitbreaker/CircuitBreakerConfiguration.java
@@ -31,7 +31,7 @@ public class CircuitBreakerConfiguration extends ConfigurationOptionProvider {
 
     private final ConfigurationOption<Boolean> circuitBreakerEnabled = ConfigurationOption.booleanOption()
         .key("circuit_breaker_enabled")
-        .tags("added[1.14.0]", "performance",  "experimental")
+        .tags("added[1.14.0]", "performance")
         .configurationCategory(CIRCUIT_BREAKER_CATEGORY)
         .description("A boolean specifying whether the circuit breaker should be enabled or not. \n" +
             "When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. \n" +
diff --git a/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/web/WebConfiguration.java b/apm-agent-core/src/main/java/co/elastic/apm/agent/impl/context/web/WebConfiguration.java
@@ -96,7 +96,7 @@ public class WebConfiguration extends ConfigurationOptionProvider {
     private final ConfigurationOption<Boolean> usePathAsName = ConfigurationOption.booleanOption()
         .key("use_path_as_transaction_name")
         .configurationCategory(HTTP_CATEGORY)
-        .tags("experimental", "added[1.0.0,Changing this value at runtime is possible since version 1.22.0]")
+        .tags("added[1.0.0,Changing this value at runtime is possible since version 1.22.0]")
         .description("If set to `true`,\n" +
             "transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.\n" +
             "\n" +
diff --git a/apm-agent-plugins/apm-dubbo-plugin/src/main/java/co/elastic/apm/agent/dubbo/AbstractDubboInstrumentation.java b/apm-agent-plugins/apm-dubbo-plugin/src/main/java/co/elastic/apm/agent/dubbo/AbstractDubboInstrumentation.java
@@ -22,12 +22,13 @@
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 
 public abstract class AbstractDubboInstrumentation extends TracerAwareInstrumentation {
 
     @Override
     public Collection<String> getInstrumentationGroupNames() {
-        return Arrays.asList("dubbo", "experimental");
+        return Collections.singleton("dubbo");
     }
 
 }
diff --git a/apm-agent-plugins/apm-jdk-httpserver-plugin/src/main/java/co/elastic/apm/agent/httpserver/JdkHttpServerInstrumentation.java b/apm-agent-plugins/apm-jdk-httpserver-plugin/src/main/java/co/elastic/apm/agent/httpserver/JdkHttpServerInstrumentation.java
@@ -20,13 +20,13 @@
 
 import co.elastic.apm.agent.bci.TracerAwareInstrumentation;
 
-import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 
 public abstract class JdkHttpServerInstrumentation extends TracerAwareInstrumentation {
 
     @Override
     public Collection<String> getInstrumentationGroupNames() {
-        return Arrays.asList("jdk-httpserver");
+        return Collections.singleton("jdk-httpserver");
     }
 }
diff --git a/apm-agent-plugins/apm-opentelemetry/apm-opentelemetry-plugin/src/main/java/co/elastic/apm/agent/opentelemetry/AbstractOpenTelemetryInstrumentation.java b/apm-agent-plugins/apm-opentelemetry/apm-opentelemetry-plugin/src/main/java/co/elastic/apm/agent/opentelemetry/AbstractOpenTelemetryInstrumentation.java
@@ -40,6 +40,6 @@ public final boolean includeWhenInstrumentationIsDisabled() {
 
     @Override
     public final Collection<String> getInstrumentationGroupNames() {
-        return Arrays.asList("opentelemetry", "experimental");
+        return Arrays.asList("opentelemetry");
     }
 }
diff --git a/docs/api-opentelemetry.asciidoc b/docs/api-opentelemetry.asciidoc
@@ -6,9 +6,6 @@ endif::[]
 [[opentelemetry-bridge]]
 === OpenTelemetry bridge
 
-NOTE: Added as experimental in 1.30.0.
-To enable it, set <<config-enable-experimental-instrumentations, `enable_experimental_instrumentations`>> to `true`.
-
 The Elastic APM OpenTelemetry bridge allows creating Elastic APM `Transactions` and `Spans`,
 using the OpenTelemetry API.
 In other words,
diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc
@@ -195,9 +195,7 @@ Click on a key to get more information.
 // This file is auto generated. Please make your changes in *Configuration.java (for example CoreConfiguration.java) and execute ConfigurationExporter
 [float]
 [[config-circuit-breaker-enabled]]
-==== `circuit_breaker_enabled` (added[1.14.0] performance experimental)
-
-NOTE: This feature is currently experimental, which means it is disabled by default and it is not guaranteed to be backwards compatible in future releases.
+==== `circuit_breaker_enabled` (added[1.14.0] performance)
 
 A boolean specifying whether the circuit breaker should be enabled or not. 
 When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. 
@@ -1471,9 +1469,7 @@ Prepending an element with `(?-i)` makes the matching case sensitive.
 // This file is auto generated. Please make your changes in *Configuration.java (for example CoreConfiguration.java) and execute ConfigurationExporter
 [float]
 [[config-use-path-as-transaction-name]]
-==== `use_path_as_transaction_name` (experimental added[1.0.0,Changing this value at runtime is possible since version 1.22.0])
-
-NOTE: This feature is currently experimental, which means it is disabled by default and it is not guaranteed to be backwards compatible in future releases.
+==== `use_path_as_transaction_name` (added[1.0.0,Changing this value at runtime is possible since version 1.22.0])
 
 If set to `true`,
 transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.
diff --git a/docs/setup-attach-api.asciidoc b/docs/setup-attach-api.asciidoc
@@ -1,8 +1,6 @@
 [[setup-attach-api]]
 === Programmatic API setup to self-attach
 
-NOTE: This installation method is in beta.
-
 [float]
 [[setup-attach-api-supported-environments]]
 ==== Supported environments
@@ -14,9 +12,6 @@ Unix and Solaris operating systems on HotSpot-based JVMs (like OpenJDK and Oracl
 [[setup-attach-api-caveats]]
 ==== Caveats
 
-The approach to mitigate `NoClassDefFoundError` s when used in OSGi containers (which includes most application servers) is experimental.
-Versions prior to 1.18.0 don't support OSGi containers.
-
 There can only be one agent instance with one configuration per JVM.
 So if you deploy multiple web applications to the same application server and call `ElasticApmAttacher.attach()` in each application,
 the first `attach()` wins and the second one will be ignored.
diff --git a/docs/setup-attach-cli.asciidoc b/docs/setup-attach-cli.asciidoc
@@ -1,8 +1,6 @@
 [[setup-attach-cli]]
 === Automatic setup with `apm-agent-attach-cli.jar`
 
-NOTE: This installation method is in beta.
-
 The `apm-agent-attach-cli.jar` is an executable Java command line program which attaches the Elastic APM Java agent to a specific JVM or to all JVMs of the same host it runs on.
 
 This installation method does not require you to alter the configuration of your application server and can be used to conveniently instrument all JVMs on a particular host.
@@ -22,13 +20,6 @@ That means it is possible to run the attacher with Java 7 and attach the agent t
 However, the type of the VM has to be the same:
 It's not possible to attach to a J9 VM from a HotSpot-based VM and vice-versa.
 
-[float]
-[[setup-attach-cli-caveats]]
-==== Caveats
-
-The approach to mitigate `NoClassDefFoundError` s when used in OSGi containers (which includes most application servers) is experimental.
-Versions prior to 1.18.0 don't support OSGi containers.
-
 [float]
 [[setup-attach-cli-download]]
 ==== Download
diff --git a/docs/supported-technologies.asciidoc b/docs/supported-technologies.asciidoc
@@ -165,7 +165,7 @@ rendering
 |com.sun.net.httpserver.HttpServer
 |1.7+
 |Captures incoming HTTP requests as transactions
-|1.25.0 (experimental)
+|1.25.0
 
 |Javalin
 |3.13.8+
@@ -329,7 +329,7 @@ The spans are named after the schema `<method> <host>`, for example `GET elastic
 
 |Apache Dubbo
 | 2.5+, except for 2.7.0, 2.7.1, and 2.7.2
-| This is an experimental plugin. Remove `experimental` from <<config-disable-instrumentations,`disable_instrumentations`>> to enable.
+|
 | 1.17.0
 
 |JDK 11 HttpClient
diff --git a/docs/tuning-and-overhead.asciidoc b/docs/tuning-and-overhead.asciidoc
@@ -147,7 +147,7 @@ Disabling <<config-capture-headers>> can save allocations, network bandwidth, an
 
 [float]
 [[circuit-breaker]]
-=== Circuit Breaker (experimental)
+=== Circuit Breaker
 
 When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state.
 If ANY of the monitors detects a stress indication, the agent will become inactive, as if the

Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,13 @@`
`22`	`22`
`23`	`23`	`import java.util.Arrays;`
`24`	`24`	`import java.util.Collection;`
	`25`	`+import java.util.Collections;`
`25`	`26`
`26`	`27`	`public abstract class AbstractDubboInstrumentation extends TracerAwareInstrumentation {`
`27`	`28`
`28`	`29`	`@Override`
`29`	`30`	`public Collection<String> getInstrumentationGroupNames() {`
`30`		`- return Arrays.asList("dubbo", "experimental");`
	`31`	`+ return Collections.singleton("dubbo");`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,13 +20,13 @@`
`20`	`20`
`21`	`21`	`import co.elastic.apm.agent.bci.TracerAwareInstrumentation;`
`22`	`22`
`23`		`-import java.util.Arrays;`
`24`	`23`	`import java.util.Collection;`
	`24`	`+import java.util.Collections;`
`25`	`25`
`26`	`26`	`public abstract class JdkHttpServerInstrumentation extends TracerAwareInstrumentation {`
`27`	`27`
`28`	`28`	`@Override`
`29`	`29`	`public Collection<String> getInstrumentationGroupNames() {`
`30`		`- return Arrays.asList("jdk-httpserver");`
	`30`	`+ return Collections.singleton("jdk-httpserver");`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,6 @@ public final boolean includeWhenInstrumentationIsDisabled() {`
`40`	`40`
`41`	`41`	`@Override`
`42`	`42`	`public final Collection<String> getInstrumentationGroupNames() {`
`43`		`- return Arrays.asList("opentelemetry", "experimental");`
	`43`	`+ return Arrays.asList("opentelemetry");`
`44`	`44`	`}`
`45`	`45`	`}`