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

Document we are not currently accepting new instrumentation probe PRs #1739

Merged
merged 10 commits into from
Feb 6, 2025
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/new_instrumentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: New Instrumentation
about: Request new instrumentation be added to the project
title: 'New Instrumentation Request for <PACKAGE>'
labels:
- enhancement
- new instrumentation
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this new instrumentation request!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: |
Please search to see if an issue already exists for the instrumentation.

If one already exists, add a 👍 to that issue and your use-case if it is not already captured.
options:
- label: I have searched the existing issues
- type: textarea
attributes:
label: Package
description: What is the name of the Go package?
validations:
required: true
- type: textarea
attributes:
label: Version
description: What version of the package do you use?
validations:
required: false
- type: textarea
attributes:
label: Environment
description: How do you normally run applications built with the package?
placeholder: As a Deployment on Kubernetes 1.30
validations:
required: true
- type: textarea
attributes:
label: Use-case
description: What kind of applications do you build with the package?
validations:
required: false
- type: textarea
attributes:
label: Telemetry
description: What telemetry you would like to see for for the package?
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ Questions, bug reports, and feature requests can all be submitted as [issues](ht

## Pull Requests

> [!NOTE]
> We are currently **not** accepting PRs to add new instrumentation probes. A
> new [instrumentation probe API] is being designed. To avoid excessive churn
> and development burden, we will not be accepting new instrumentation probes
> until that API is completed.
>
> Please **do** [open an issue] to track your request for new instrumentation.
> We would like to know what we are missing and how you plan to use it.

[open an issue]: https://github.com/open-telemetry/opentelemetry-go-instrumentation/issues/new?template=new_instrumentation.yaml
[instrumentation API]: https://github.com/open-telemetry/opentelemetry-go-instrumentation/issues/1105

### How to Send Pull Requests

Everyone is welcome to contribute code to `opentelemetry-go-instrumentation` via
Expand Down
Loading