The Visual Studio Code Extension (VSCode) for New Relic helps developers build and deploy New Relic apps directly from VSCode. The extension allows you to use New Relic CLI commands to build custom apps, manage your apps, and gather the information you need to successfully add your app to the New Relic One Catalog. For reference materials, you can also open and search developer documentation directly in the CLI.
How to develop locally and contribute changes
Before you start coding, be sure you've done the following:
-
Create a free account
-
Get your API key
-
Install the
nr1
CLI here
Note: A nerdpack will be created under the account associated with the current default profile
- Install the extension from the VS Code Marketplace.
- Open the VS Code command palette (
Ctrl+Shift+P
in Windows/Linux orCmd+Shift+P
in macOS). - Enter "New Relic" to get a list of the available commands.
- Select
New Relic (profile): select default
orNew Relic (nerdpack): create a nerdpack
to get started!
These are the features currently supported by this extension.
Name | Description |
---|---|
New Relic (profile): select default |
Choose your default profile ℹ️ |
New Relic (profile): add a new or existing profile |
Add a new or existing New Relic profile |
New Relic (nerdpack): generate uuid |
Assign a new UUID to your Nerdpack ℹ️ |
New Relic (nerdpack): create a nerdpack |
Create a new component from a Nerdpack template ℹ️ |
New Relic (nerdpack): create a nerdlet |
Creates a new component from a Nerdlet template ℹ️ |
New Relic (nerdpack): create a launcher |
Create a new component from a Launcher template ℹ️ |
New Relic (nerdpack): run local development |
Launch a local server to test your Nerdpack on the New Relic One platform ℹ️ |
New Relic (nerdpack): publish |
Publishes your Nerdpack to New Relic ℹ️ |
New Relic (nerdpack): deploy |
Deploys a Nerdpack version to a specific channel (DEV, BETA, or STABLE). ℹ️ |
New Relic (nerdpack): undeploy |
Undeploys a Nerdpack version from a specific channel (for example, DEV, BETA, or STABLE) ℹ️ |
New Relic (nerdpack): subscribe account to nerdpack |
Subscribes your account to a specific Nerdpack and channel ℹ️ |
New Relic (nerdpack): unsubscribe account from nerdpack |
Unsubscribes your account from a specific Nerdpack ℹ️ |
New Relic (profile): show subscribed nerdpacks |
Lists all the Nerdpacks your account is subscribed to ℹ️ |
New Relic (nerdpack): create catalog listing |
Creates a new listing from the Catalog template ℹ️ |
New Relic (nerdpack): submit catalog listing |
Gathers the information you add to the catalog directory for your application and saves it to the New Relic One Catalog ℹ️ |
New Relic (nerdpack): show published catalog listing info |
Shows the information about your application that's displayed in the New Relic One Catalog. ℹ️ |
New Relic (docs): open developer documentation |
Go to developer.newrelic.com |
New Relic (docs): search developer documentation |
Search through New Relic developer documentation |
There are snippets for each component listed on developer.newrelic.com, each trigger is preceded by NR1
to make them easy to access.
If you notice any components are missing please open an issue, or you can contribute the snippet yourself using the guidelines below.
This project adheres to a Code of Conduct. Please read before contributing.
- Fork this repository.
- Open project in VS Code.
- Hit
F5
to compile and launch the extension in debug mode. This will open a new VS Code window in which you can open the Command Palette and try out the commands. - Make your changes in a new branch.
- Commit and push your changes.
- Open a pull request with a description of the changes. Feel free to include anything that could make our review easier (screenshots, demo gifs, etc.).
This project is distributed under the Apache 2 license.
Report issues on our GitHub repository.
We also encourage pull requests if you want to help make the extension even better.