OpenTelemetry Collector components is a New Relic's repository that contains custom Collector's components. Those components are either in process of being accepted by the community or removed (e.g deprecated) from upstream.
Components owners are specified in CODEOWNERS file.
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices.
- Roadmap - As part of the Developer Toolkit, the roadmap for this project follows the same RFC process
- Issues or Enhancement Requests - Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
- Contributors Guide - Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself 😁).
- Community discussion board - Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub.
Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at opensource@newrelic.com.
Before writing any code, check the development guides and open an issue with the corresponding information. For current components, you can check its maintainers in the CODEOWNERS file.
The nopreceiver is a "no operation" component of type receiver that can be used as helper package when starting a new component.
- Go 1.20.0+
- GNU Make
- git
Before contributing, all linting and tests must pass. Each component must be a Go module and include the Makefile.Common, in its Makefile:
include ../../Makefile.CommonAll available targets can be checked with:
# See make helpers
$ make help
Using the following format for commit messages allows for auto-generation of the CHANGELOG:
<type>(<scope>): <subject>
| Type | Description | Change log? |
|---|---|---|
chore |
Maintenance type work | No |
docs |
Documentation Updates | Yes |
feat |
New Features | Yes |
fix |
Bug Fixes | Yes |
refactor |
Code Refactoring | No |
This refers to what part of the code is the focus of the work. For example:
General:
./.github- Work related to test and build the system (linting, owners, CI/CD, etc)../receiver/- OpenTelemetry collector receivers../internal/- Common testing packages and components import../cmd/nrotelcomponents/- Testing collector that includes all custom components.
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR SUPPORT, although you can report issues and contribute to the project here on GitHub.
Please do not report issues with this software to New Relic Global Technical Support.
We encourage your contributions to improve the New Relic OpenTelemetry Components! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
If you would like to contribute to this project, review these guidelines.
To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to Project Name.
This project is distributed under the Apache 2 license.
