Skip to content
Cloud optimization.
JavaScript CSS
Branch: master
Clone or download
Latest commit 5d69660 Nov 13, 2019

README.md

Cloud Optimize (nr1-cloud-optimize)

GitHub release (latest SemVer including pre-releases) Snyk

Usage

This application analyzes your cloud environment, and figures out where you're wasting money on excess cloud capacity. The application compares the size of your instances to their utilization, and estimates how much you could save by optimizing the size.

Support

  • AWS
  • Azure
  • GCP

    Note: When the instanceType attribute is available on the SystemSample event, the appropriate instanceType will be detected against the relevant cloud provider, if this attribute returns unknown or is not available the automatic instanceType detection will not work. To ensure the best level of support it is recommended to configure the appropriate Infrastructure Cloud Integrations to have the additional metadata decorated and available eg. EC2 Integration, Azure VMs, Google Compute Engine.
    To confirm you can use the following query for eg. SELECT * FROM SystemSample WHERE hostname = 'my-host' and confirm the instanceType attribute.

Screenshot #1 Screenshot #2 Screenshot #3 In-Context Application Optimization requires APM

Open Source License

This project is distributed under the Apache 2 license.

What do you need to make this work?

Required:

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

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.

# If you need to create a new uuid for the account to which you're deploying this Nerdpack, use the following
# nr1 nerdpack:uuid -g [--profile=your_profile_name]
# to see a list of APIkeys / profiles available in your development environment, run nr1 credentials: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

Support

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.

Community

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/t/cloud-optimizer-nerdpack/82936 (Note: URL subject to change before GA)

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.

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 opensource@newrelic.com.

You can’t perform that action at this time.