|
| 1 | +--- |
| 2 | +name: Instrumentation Request |
| 3 | +about: Suggest instrumentation to include in this project |
| 4 | +title: Add Instrumentation for <package-name> |
| 5 | +labels: 'enhancement, area: instrumentation, release:after-ga' |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## Background |
| 11 | + |
| 12 | +**Package Link**: <add link to package here> |
| 13 | + |
| 14 | +<describe how this package is commonly used> |
| 15 | + |
| 16 | +## Proposed Solution |
| 17 | + |
| 18 | +<add a high-level description of how instrumentation can wrap or hook-in to the package> |
| 19 | + |
| 20 | +### Tracing |
| 21 | + |
| 22 | +- attributes: |
| 23 | + - <add proposed attributes or remove> |
| 24 | +- events: |
| 25 | + - <add proposed events or remove> |
| 26 | +- links: |
| 27 | + - <add proposed links or remove> |
| 28 | + |
| 29 | +### Metrics |
| 30 | + |
| 31 | +Instruments |
| 32 | + |
| 33 | +- <instrument name>: <describe what the instrument will measure> |
| 34 | + - type: <propose instrument type information> |
| 35 | + - unit: <propose instrument unit> |
| 36 | + - description: <propose instrument description> |
| 37 | + - attributes: |
| 38 | + - <add proposed attributes or remove> |
| 39 | + |
| 40 | +### Prior Art |
| 41 | + |
| 42 | +- <list other established instrumentation for this package that can be referenced> |
| 43 | + |
| 44 | +## Tasks |
| 45 | + |
| 46 | +- Code complete: |
| 47 | + - [ ] Comprehensive unit tests. |
| 48 | + - [ ] End-to-end integration tests. |
| 49 | + - [ ] Tests all passing. |
| 50 | + - [ ] Instrumentation functionality verified. |
| 51 | +- Documented |
| 52 | + - [ ] Added to the [OpenTelemetry Registry](https://opentelemetry.io/registry/) |
| 53 | + - [ ] README included for the module describing high-level purpose. |
| 54 | + - [ ] Complete documentation of all public API including package documentation. |
| 55 | + - [ ] [Instrumentation documentation](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/master/instrumentation/README.md#instrumentation-packages) updated. |
| 56 | +- Examples |
| 57 | + - [ ] `Dockerfile` file to build example application. |
| 58 | + - [ ] `docker-compose.yml` to run example in a docker environment to demonstrate instrumentation. |
0 commit comments