Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/personio/newrelic-alert-manager

Kubernetes operator for managing New Relic alerts and dashboards
https://github.com/personio/newrelic-alert-manager

kubernetes kubernetes-operator newrelic operator-sdk

Last synced: about 24 hours ago
JSON representation

Kubernetes operator for managing New Relic alerts and dashboards

Host: GitHub
URL: https://github.com/personio/newrelic-alert-manager
Owner: personio
License: mit
Created: 2020-02-03T13:02:59.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-06-12T05:59:20.000Z (over 1 year ago)
Last Synced: 2024-05-22T14:31:26.714Z (6 months ago)
Topics: kubernetes, kubernetes-operator, newrelic, operator-sdk
Language: Go
Homepage:
Size: 17.5 MB
Stars: 24
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

# New Relic alert manager

[![Build Status](https://travis-ci.org/personio/newrelic-alert-manager.svg?branch=master)](https://travis-ci.org/personio/newrelic-alert-manager)

newrelic-alert-manager is a Kubernetes operator which automates the management of
New Relic dashboards, alert policies and notification channels.

It allows end users of a Kubernetes cluster to define these resources as [Kubernetes Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)

## Project status
The project is currently considered stable and suitable for production use.

## Supported features
### Alerts
The newrelic-alert-manager currently supports the management of the following alerting conditions
* [NRQL alerting conditions](https://docs.newrelic.com/docs/alerts/new-relic-alerts/defining-conditions/create-alert-conditions-nrql-queries)
* [APM alerting conditions](https://docs.newrelic.com/docs/alerts/new-relic-alerts/defining-conditions/create-alert-conditions)
* [Infra alerting conditions](https://docs.newrelic.com/docs/infrastructure/new-relic-infrastructure/infrastructure-alert-conditions/rest-api-calls-new-relic-infrastructure-alerts) of type `infra_metric`

If you are unable to create a particular alerting condition due to lack of support by the operator or the New Relic API,
you can try to fall back to defining it as a NRQL alerting condition instead.
One such example is given in the [FAQ](https://github.com/personio/newrelic-alert-manager#how-do-i-create-an-apm-condition-of-type-web-transaction-percentiles) section.

### Notification channels

With respect to notification channels, the currently supported types are Email, Slack and Opsgenie channels.

### Dashboards
The dashboard API is fully covered by the operator.

## Deployment
In order to deploy the operator, execute the following steps:

* Download and extract the Kubernetes manifests (deploy.tar.gz) for the [latest release](https://github.com/personio/newrelic-alert-manager/releases)
* Add your secrets to `deploy/1-secret.yaml`
* Add the base64 encoded New Relic admin password
* Optionally, add the default Slack webhook URL for `SlackNotificationChannel`s.
* Optionally, add the Opsgenie API key for `OpsgenieNotificationChannel`s.
* Deploy the custom resource definitions by running
```kubectl apply -f deploy/crds/```
* Deploy the operator manifests by running
```kubectl apply -f deploy/```

## Example Usage
Please check the [examples](https://github.com/personio/newrelic-alert-manager/tree/master/hack/examples) folder to find out how to deploy alert policies together with notification channels.

For more detailed information, you can take a look at the [complete API reference](https://github.com/personio/newrelic-alert-manager/tree/master/docs).

## Debugging resources
If you applied an alert policy but it was not created in New Relic, you can check the
status of the policy using `kubectl describe alertpolicies `. If there was an error while creating the policy, it will be shown in the `Status.reason` field.
Similarly, you can use `kubectl describe` to debug dashboards and notification channels as well.

## FAQ
### Where can I find a more information on how each alerting condition parameter affects the alert policy?
The alert condition parameters are best explained by the documentation for the New Relic REST API
Some examples include:
* [apmConditions.alertThreshold.metric](https://docs.newrelic.com/docs/alerts/rest-api-alerts/new-relic-alerts-rest-api/alerts-conditions-api-field-names#metric)
* [apmConditions.alertThreshold.timeFunction](https://docs.newrelic.com/docs/alerts/rest-api-alerts/new-relic-alerts-rest-api/alerts-conditions-api-field-names#terms_time_function)
* [nrqlConditions.valueFunction](https://docs.newrelic.com/docs/alerts/rest-api-alerts/new-relic-alerts-rest-api/alerts-conditions-api-field-names#user_defined_value_function)

You can review the [Alerts conditions API field names](https://docs.newrelic.com/docs/alerts/rest-api-alerts/new-relic-alerts-rest-api/alerts-conditions-api-field-names) page for more information.

### How do I create an APM condition of type Web transaction percentiles
Unfortunately, it is [not possible](https://docs.newrelic.com/docs/alerts/rest-api-alerts/new-relic-alerts-rest-api/rest-api-calls-new-relic-alerts#excluded) to use New Relic's REST API to create these types of conditions.
However, you can try to define a NRQL alerting condition instead. The query parameter could be defined as follows:
```
SELECT percentile(totalTime) FROM Transaction WHERE appName = ''
```