Merge pull request #121 from grails/merge-4.1.x-into-5.0.x

Merge 4.1.x into 5.0.x
grails · Dec 24, 2024 · d85ec9b · d85ec9b
2 parents bf90bb9 + 2d4272f
commit d85ec9b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -94,6 +94,18 @@ By default, no test recording will be performed.  Various system properties exis
     * possible values are `FLV` or `MP4`
     * defaults to `MP4`
 
+#### Observability and Tracing
+Selenium integrates with [OpenTelemetry](https://opentelemetry.io) to support observability and tracing out of the box. By default, Selenium [enables tracing](https://www.selenium.dev/blog/2021/selenium-4-observability).
+
+This plugin, however, **disables tracing by default** since most setups lack an OpenTelemetry collector to process the traces.
+
+To enable tracing, set the following system property:
+* `grails.geb.tracing.enabled`
+  * possible values are `true` or `false`
+  * defaults to `false`
+
+This allows you to opt in to tracing when an OpenTelemetry collector is available.
+
 ### GebSpec
 
 If you choose to extend `GebSpec`, you will need to have a [Selenium WebDriver](https://www.selenium.dev/documentation/webdriver/browsers/) installed that matches a browser you have installed on your system.

diff --git a/src/testFixtures/groovy/grails/plugin/geb/GrailsGebSettings.groovy b/src/testFixtures/groovy/grails/plugin/geb/GrailsGebSettings.groovy
@@ -38,13 +38,15 @@ class GrailsGebSettings {
     private static VncRecordingMode DEFAULT_RECORDING_MODE = VncRecordingMode.SKIP
     private static VncRecordingFormat DEFAULT_RECORDING_FORMAT = VncRecordingFormat.MP4
 
+    String tracingEnabled
     String recordingDirectoryName
     String reportingDirectoryName
     VncRecordingMode recordingMode
     VncRecordingFormat recordingFormat
     LocalDateTime startTime
 
     GrailsGebSettings(LocalDateTime startTime) {
+        tracingEnabled = System.getProperty('grails.geb.tracing.enabled', 'false')
         recordingDirectoryName = System.getProperty('grails.geb.recording.directory', 'build/gebContainer/recordings')
         reportingDirectoryName = System.getProperty('grails.geb.reporting.directory', 'build/gebContainer/reports')
         recordingMode = VncRecordingMode.valueOf(

diff --git a/src/testFixtures/groovy/grails/plugin/geb/WebDriverContainerHolder.groovy b/src/testFixtures/groovy/grails/plugin/geb/WebDriverContainerHolder.groovy
@@ -98,15 +98,13 @@ class WebDriverContainerHolder {
         }
 
         currentConfiguration = specConfiguration
-        currentContainer = new BrowserWebDriverContainer()
-        if (grailsGebSettings.recordingEnabled) {
-            currentContainer = currentContainer.withRecordingMode(
-                    grailsGebSettings.recordingMode,
-                    grailsGebSettings.recordingDirectory,
-                    grailsGebSettings.recordingFormat
-            )
-        }
+        currentContainer = new BrowserWebDriverContainer().withRecordingMode(
+                grailsGebSettings.recordingMode,
+                grailsGebSettings.recordingDirectory,
+                grailsGebSettings.recordingFormat
+        )
         currentContainer.tap {
+            withEnv('SE_ENABLE_TRACING', grailsGebSettings.tracingEnabled)
             withAccessToHost(true)
             start()
         }