Skip to content

Latest commit

 

History

History
executable file
·
80 lines (58 loc) · 4.57 KB

README.md

File metadata and controls

executable file
·
80 lines (58 loc) · 4.57 KB

New Relic logo

Steadybit extension-newrelic

A Steadybit extension for New Relic.

Learn about the capabilities of this extension in our Reliability Hub.

Configuration

Environment Variable Helm value Meaning Required Default
STEADYBIT_EXTENSION_API_BASE_URL newrelic.apiBaseUrl The New Relic API Base Url, like 'https://api.newrelic.com' or 'https://api.eu.newrelic.com' yes
STEADYBIT_EXTENSION_API_KEY newrelic.apiKey The New Relic API Key, Type: USER yes
STEADYBIT_EXTENSION_INSIGHTS_COLLECTOR_API_BASE_URL newrelic.insightsCollectorApiBaseUrl The New Relic Ingest API Base Url, like 'https://insights-collector.newrelic.com' or 'https://insights-collector.eu01.nr-data.net' yes
STEADYBIT_EXTENSION_INSIGHTS_COLLECTOR_API_KEY newrelic.insightsCollectorApiKey The New Relic Ingest API Key, Type: INGEST - LICENSE yes

The extension supports all environment variables provided by steadybit/extension-kit.

Installation

Kubernetes

Detailed information about agent and extension installation in kubernetes can also be found in our documentation.

Recommended (via agent helm chart)

All extensions provide a helm chart that is also integrated in the helm-chart of the agent.

You must provide additional values to activate this extension.

--set extension-newrelic.enabled=true \
--set extension-newrelic.newrelic.apiBaseUrl={{YOUR-API-BASE-URL}} \
--set extension-newrelic.newrelic.apiKey={{YOUR-API-KEY}} \
--set extension-newrelic.newrelic.insightsCollectorApiBaseUrl={{YOUR-INSIGHTS-COLLECTOR-API-BASE-URL}} \
--set extension-newrelic.newrelic.insightsCollectorApiKey={{YOUR-INSIGHTS-COLLECTOR-API-KEY}} \

Additional configuration options can be found in the helm-chart of the extension.

Alternative (via own helm chart)

If you need more control, you can install the extension via its dedicated helm-chart.

helm repo add steadybit-extension-newrelic https://steadybit.github.io/extension-newrelic
helm repo update
helm upgrade steadybit-extension-newrelic \
    --install \
    --wait \
    --timeout 5m0s \
    --create-namespace \
    --namespace steadybit-agent \
    --set newrelic.apiBaseUrl={{YOUR-API-BASE-URL}} \
    --set newrelic.apiKey={{YOUR-API-KEY}} \
    --set newrelic.insightsCollectorApiBaseUrl={{YOUR-INSIGHTS-COLLECTOR-API-BASE-URL}} \
    --set newrelic.insightsCollectorApiKey={{YOUR-INSIGHTS-COLLECTOR-API-KEY}} \
    steadybit-extension-newrelic/steadybit-extension-newrelic

Linux Package

Please use our agent-linux.sh script to install the extension on your Linux machine. The script will download the latest version of the extension and install it using the package manager.

After installing, configure the extension by editing /etc/steadybit/extension-newrelic and then restart the service.

Extension registration

Make sure that the extension is registered with the agent. In most cases this is done automatically. Please refer to the documentation for more information about extension registration and how to verify.