Merge pull request #97 from DataDog/anmarchenko/experimental_tslv_readme

add note to README.md about test suite level visibility feature
DataDog · Jan 8, 2024 · f3be528 · f3be528
2 parents 867b86e + 6122329
commit f3be528
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -134,6 +134,30 @@ Datadog.configure { |c| c.ci.agentless_mode_enabled = true }
 
 ## Additional configuration
 
+### Experimental test suite level visibility support
+
+Test suite level visibility (TSLV) is available in experimental mode and disabled by default (yet).
+To enable it add the following line to Datadog configuration:
+
+```ruby
+Datadog.configure do |c|
+  #  ... usual ci configs ...
+  c.ci.experimental_test_suite_level_visibility_enabled = true
+end
+```
+
+This will enable visibility into how your test suites and test sessions behave, providing
+insights about performance and reliability on test suite/session level. Please submit your feedback
+and any issues encountered via Github issues.
+
+Example test suite trace for Ruby project:
+
+![test level visibility trace](./docs/screenshots/tslv-trace.jpeg)
+
+Example test suite level visibility dashboard for a set of Ruby projects:
+
+![test level visibility trace](./docs/screenshots/tslv-dashboard.jpeg)
+
 ### Add tracing instrumentations
 
 It can be useful to have rich tracing information about your tests that includes time spent performing database operations

diff --git a/docs/screenshots/tslv-dashboard.jpeg b/docs/screenshots/tslv-dashboard.jpeg
diff --git a/docs/screenshots/tslv-trace.jpeg b/docs/screenshots/tslv-trace.jpeg