Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instrumentation request issue templates #500

Merged
merged 2 commits into from
Dec 29, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/instrumentation-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Instrumentation Request
about: Suggest instrumentation to include in this project
title: Add Instrumentation for <package-name>
labels: 'enhancement, area: instrumentation, release:after-ga'
assignees: ''

---

## Background

**Package Link**: <add link to package here>

<describe how this package is commonly used>

## Proposed Solution

<add a high-level description of how instrumentation can wrap or hook-in to the package>

### Tracing

- attributes:
- <add proposed attributes or remove>
- events:
- <add proposed events or remove>
- links:
- <add proposed links or remove>

### Metrics

Instruments

- <instrument name>: <describe what the instrument will measure>
- type: <propose instrument type information>
- unit: <propose instrument unit>
- description: <propose instrument description>
- attributes:
- <add proposed attributes or remove>

### Prior Art

- <list other established instrumentation for this package that can be referenced>

## Tasks

- Code complete:
- [ ] Comprehensive unit tests.
- [ ] End-to-end integration tests.
- [ ] Tests all passing.
- [ ] Instrumentation functionality verified.
- Documented
- [ ] Added to the [OpenTelemetry Registry](https://opentelemetry.io/registry/)
- [ ] README included for the module describing high-level purpose.
- [ ] Complete documentation of all public API including package documentation.
- [ ] [Instrumentation documentation](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/master/instrumentation/README.md#instrumentation-packages) updated.
- Examples
- [ ] `Dockerfile` file to build example application.
- [ ] `docker-compose.yml` to run example in a docker environment to demonstrate instrumentation.