The New Relic Developer Toolkit is a suite of tools expressly built to ease the configuration, management, and usage of New Relic through automation. This repo serves as a central location for you to discover the tools currently available, see what's being worked on right now, and provide feedback.
Request for Comments!
We've recently published our Roadmap and have sumbitted this to the community for review. If you have any questions or comments, please contribute to the thread in our discussion forum.
- General Resources
- Project Website - Main source of information about the Developer Toolkit
- Roadmap - Current and future work priorities
- Kanban Board - Current work across all tools
- Tools in the Toolkit
- Support
Ready to jump right in? Excellent! Here are some quick reference guides to assist you in your journey to increased consistency and decreased toil:
- New Relic Terraform Provider
- Quick Start Video - Walk through how to configure New Relic via Terraform in just a few minutes.
- Getting Started Guide - Easy to follow example to get you started.
- New Relic CLI
- Quick Start Video - Overview of the key features the New Relic CLI provides (Spoiler: Deployment Markers, Tag Management, and more!)
- Getting Started Guide - For the quick copy/pasters out there. Get started ASAP.
- New Relic Client
- Example usage - Quick overview of importing this library into your own application.
- New Relic AWS CloudFormation Integration
- Documentation - Get up and running with New Relic + CloudFormation for NRQL Alerting
The New Relic Terraform Provider enables Observability as Code, reducing developer toil, and allows users to manage their entire ecosystem in a single place.
The New Relic Client provides the building blocks for many tools in the toolkit, enabling quick access to the suite of New Relic APIs. As a library, it can also be leveraged within your own custom applications.
- Documentation
- Repo
- Project Boards
The New Relic CLI enables integration of New Relic into your existing workflows. Be it fetching data from your laptop while troubleshooting an issue, or adding New Relic into your CI/CD pipeline.
- Documentation
- Repo
- Project Boards
The AWS CloudFormation Integration enables developers using CloudFormation to easily provision a subset of New Relic resources.
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. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
https://discuss.newrelic.com/c/build-on-new-relic/
The link for the Developer Toolkit discussion can be found here:
https://discuss.newrelic.com/c/build-on-new-relic/developer-toolkit
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.
Contributions are welcome (and if you submit a Enhancement Request, expect to be invited to contribute it yourself ๐). Please review our Contributors Guide.
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 [email protected].
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.
This project is distributed under the Apache 2 license.
This repo mostly contains a site for GitHub Pages, which is rendered via Jekyll. In order to test local changes, you'll need the following:
- Ruby 2.6.5 (rbenv suggested!)
- Bundler
Once you have installed the above requirements:
cd docs/
bundle install
bundle exec jekyll serve