Skip to content

Commit cb65a92

Browse files
add documentation note about how to add instrumentation tests to CI [LANGPLAT-352] (#3690)
Co-authored-by: Dario Castañé <[email protected]>
1 parent 0ae23bf commit cb65a92

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

contrib/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://pkg.go.dev/github.com/DataDog/dd-trace-go/v2/contrib)
22

3-
The purpose of these packages is to provide tracing on top of commonly used packages from the standard library as well as the
3+
The purpose of these packages is to provide tracing on top of commonly used packages from the standard library as well as the
44
community in a "plug-and-play" manner. This means that by simply importing the appropriate path, functions are exposed having
5-
the same signature as the original package. These functions return structures that embed the original return value, allowing
5+
the same signature as the original package. These functions return structures that embed the original return value, allowing
66
them to be used as they normally would with tracing activated out of the box.
77

88
All of these libraries are supported by our [APM product](https://www.datadoghq.com/apm/).
@@ -36,6 +36,10 @@ Third, some guidelines to follow on naming functions:
3636

3737
Each integration comes with a thorough documentation and usage examples. A good overview can be seen on our [godoc](https://pkg.go.dev/github.com/DataDog/dd-trace-go/v2/contrib) page.
3838

39+
### Tests
40+
41+
Write tests for your new integration and include them in a file ``<name>_test.go``. This will cause your new tests to be automatically run by the Continuous Integration system on new pull requests.
42+
3943
### Instrumentation telemetry
4044

4145
Every integration is expected to import instrumentation telemetry to gather integration usage (more info [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection)). Instrumentation telemetry can be enabled by adding the following `init` function to the new contrib package:

0 commit comments

Comments
 (0)