Optimizer (nr1-cloud-optimize)

Usage

This application analyzes your environment using various integrations eg. Cloud Integrations, Infrastructure Agent, Kubernetes etc. It shows cost and performance metrics per service so you can understand the potential impact to your environment as well as utilize the cost optimization suggestions.

Features

• Historical Tracking

  • Compare & analysis before and after or against major events eg. Black friday

• Time range support

  • Isolate costs during specific periods

• Tag filtering

  • Isolate costs during specific periods

• Tuneable suggestions system (beta)

  • Provide high level insights and recommendations to teams

Service support

Contributing and improving

We are open to all suggestions that will help to improve the analysis, suggestions, services and any other capability you can think off. Please raise an issue with as much detail as possible.

Screenshots

Open Source License

This project is distributed under the Apache 2 license.

Dependencies

Requires New Relic Infrastructure.

You'll get the best possible data out of this application if you also:

• Activate the EC2 integration to group by your AWS cloud provider account.
• Activate the Azure VMs integration to group by your Azure cloud provider account.
• Activate the Google Compute integration to group by your GCP cloud provider account.
• Install APM on your applications to group by application.
• Install the Kubernetes integration for node and container optimizations

Getting started

First, ensure that you have Git and NPM installed. If you're unsure whether you have one or both of them installed, run the following command(s) (If you have them installed these commands will return a version number, if not, the commands won't be recognized):

git --version
npm -v

Next, install the NR1 CLI by going to this link and following the instructions (5 minutes or less) to install and setup your New Relic development environment.

Next, to clone this repository and run the code locally against your New Relic data, execute the following commands:

nr1 nerdpack:clone -r https://github.com/newrelic/nr1-cloud-optimize.git
cd nr1-cloud-optimize
nr1 nerdpack:serve

Visit https://one.newrelic.com/?nerdpacks=local, navigate to the Nerdpack, and ✨

Deploying this Nerdpack

Open a command prompt in the nerdpack's directory and run the following commands.

# To create a new uuid for the nerdpack so that you can deploy it to your account:
# nr1 nerdpack:uuid -g [--profile=your_profile_name]

# To see a list of API keys / profiles available in your development environment:
# nr1 profiles:list

nr1 nerdpack:publish [--profile=your_profile_name]
nr1 nerdpack:deploy [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]
nr1 nerdpack:subscribe [-c [DEV|BETA|STABLE]] [--profile=your_profile_name]

Visit https://one.newrelic.com, navigate to the Nerdpack, and ✨

Community Support

New Relic hosts and moderates an online forum where you can interact with New Relic employees as well as other customers to get help and share best practices. Like all New Relic open source community projects, there's a related topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

https://discuss.newrelic.com/t/cloud-optimizer-nerdpack/82936

Please do not report issues with Optimizer to New Relic Global Technical Support. Instead, visit the Explorers Hub for troubleshooting and best-practices.

Issues / 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.

Security

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.

Contributing

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].