Add Setting to Disable Tracing (#120)

* fix: add setting to disable tracing

Close gh-119

* docs: document `grails.geb.tracing.enabled` setting

Author: matrei

README.md

@@ -76,6 +76,18 @@ By default, no test recording will be performed.  Here are the system properties
     * 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.

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(

src/testFixtures/groovy/grails/plugin/geb/WebDriverContainerHolder.groovy

@@ -104,6 +104,7 @@ class WebDriverContainerHolder {
                 grailsGebSettings.recordingFormat
         )
         currentContainer.tap {
+            withEnv('SE_ENABLE_TRACING', grailsGebSettings.tracingEnabled)
             withAccessToHost(true)
             start()
         }