Skip to content

Commit 41fc85d

Browse files
committed
add documentation note about how to add instrumentation tests to CI
1 parent faeb62c commit 41fc85d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/how_instrumentations_work.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,8 @@ example, [`ShutdownInstrumentation`](https://github.com/DataDog/dd-trace-java/bl
203203
or [`UrlInstrumentation`](https://github.com/DataDog/dd-trace-java/blob/3e81c006b54f73aae61f88c39b52a7267267075b/dd-java-agent/instrumentation/http-url-connection/src/main/java/datadog/trace/instrumentation/http_url_connection/UrlInstrumentation.java#L21).
204204

205205
> [!NOTE]
206-
> Without classloader available, helper classes for bootstrap instrumentation must be place into the
207-
> `:dd-java-agent:agent-bootstrap` module rather than loaded using [the default mechanism](#helper-classes).
206+
> Without classloader available, helper classes for bootstrap instrumentation must be place into the
207+
> `:dd-java-agent:agent-bootstrap` module rather than loaded using [the default mechanism](#helper-classes).
208208
209209
### Method Matching
210210

@@ -677,6 +677,8 @@ Tests are written in Groovy using the [Spock framework](http://spockframework.or
677677
instrumentations, `AgentTestRunner` must be extended. For example, HTTP server frameworks use base tests which enforce
678678
consistency between different implementations (
679679
see [HttpServerTest](../dd-java-agent/testing/src/main/groovy/datadog/trace/agent/test/base/HttpServerTest.groovy)).
680+
Such Groovy-based tests are included by default in the CI instrumentation test jobs.
681+
680682
When writing an instrumentation it is much faster to test just the instrumentation rather than build the entire project,
681683
for example:
682684

0 commit comments

Comments
 (0)