RepoMirrors
/
alertmanager
mirror of https://github.com/prometheus/alertmanager
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#2032) 

* Update README.md

Minor grammar fixes. Mostly correcting capitalization.

Signed-off-by: Oddlittlebird <oddlittlebird@gmail.com>

* Update README.md

Applied edits

Signed-off-by: Oddlittlebird <oddlittlebird@gmail.com>

* Update README.md

Removed a period and deleted unnecessary lines from License section

Signed-off-by: Oddlittlebird <oddlittlebird@gmail.com>

* Reword the contributing section

Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
oddlittlebird 2019-09-18 05:54:46 -07:00 committed by Simon Pasquier
parent 223dd6c47b
commit bc6dd0dd46
2 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@ -1,3 +0,0 @@
# Contributing
Please check the [Prometheus contributing page](https://github.com/prometheus/prometheus/blob/master/CONTRIBUTING.md).

51
README.md
View File

@ -1,13 +1,12 @@
# Alertmanager [![CircleCI](https://circleci.com/gh/prometheus/alertmanager/tree/master.svg?style=shield)][circleci]
[![Docker Repository on Quay](https://quay.io/repository/prometheus/alertmanager/status)][quay]
[![Docker Repository on Quay](https://quay.io/repository/prometheus/alertmanager/status "Docker Repository on Quay")][quay]
[![Docker Pulls](https://img.shields.io/docker/pulls/prom/alertmanager.svg?maxAge=604800)][hub]
The Alertmanager handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver integrations such as email, PagerDuty, or OpsGenie. It also takes care of silencing and inhibition of alerts.
* [Documentation](http://prometheus.io/docs/alerting/alertmanager/)
## Install
There are various ways of installing Alertmanager.
@ -33,7 +32,7 @@ $ GO15VENDOREXPERIMENT=1 go get github.com/prometheus/alertmanager/cmd/...
$ alertmanager --config.file=<your_file>
```
Or checkout the source code and build manually:
Or clone the repository and build manually:
```
$ mkdir -p $GOPATH/src/github.com/prometheus
@ -193,9 +192,9 @@ relate to `/alertmanager/api/v2/status`.
_API v2 is still under heavy development and thereby subject to change._
## Amtool
## amtool
`amtool` is a cli tool for interacting with the alertmanager api. It is bundled with all releases of alertmanager.
`amtool` is a cli tool for interacting with the Alertmanager API. It is bundled with all releases of Alertmanager.
### Install
@ -206,7 +205,7 @@ go get github.com/prometheus/alertmanager/cmd/amtool
### Examples
View all currently firing alerts
View all currently firing alerts:
```
$ amtool alert
Alertname Starts At Summary
@ -216,7 +215,7 @@ Check_Foo_Fails 2017-08-02 18:30:18 UTC This is a testing alert!
Check_Foo_Fails 2017-08-02 18:30:18 UTC This is a testing alert!
```
View all currently firing alerts with extended output
View all currently firing alerts with extended output:
```
$ amtool -o extended alert
Labels Annotations Starts At Ends At Generator URL
@ -226,7 +225,7 @@ alertname="Check_Foo_Fails" instance="node0" link="https://example.com" summary
alertname="Check_Foo_Fails" instance="node1" link="https://example.com" summary="This is a testing alert!" 2017-08-02 18:31:24 UTC 0001-01-01 00:00:00 UTC http://my.testing.script.local
```
In addition to viewing alerts you can use the rich query syntax provided by alertmanager
In addition to viewing alerts, you can use the rich query syntax provided by Alertmanager:
```
$ amtool -o extended alert query alertname="Test_Alert"
Labels Annotations Starts At Ends At Generator URL
@ -243,7 +242,7 @@ Labels Annotations
alertname="Test_Alert" instance="node1" link="https://example.com" summary="This is a testing alert!" 2017-08-02 18:31:24 UTC 0001-01-01 00:00:00 UTC http://my.testing.script.local
```
Silence an alert
Silence an alert:
```
$ amtool silence add alertname=Test_Alert
b3ede22e-ca14-4aa0-932c-ca2f3445f926
@ -252,7 +251,7 @@ $ amtool silence add alertname="Test_Alert" instance=~".+0"
e48cb58a-0b17-49ba-b734-3585139b1d25
```
View silences
View silences:
```
$ amtool silence query
ID Matchers Ends At Created By Comment
@ -263,12 +262,12 @@ ID Matchers Ends A
e48cb58a-0b17-49ba-b734-3585139b1d25 alertname=Test_Alert instance=~.+0 2017-08-02 22:41:39 UTC kellel
```
Expire a silence
Expire a silence:
```
$ amtool silence expire b3ede22e-ca14-4aa0-932c-ca2f3445f926
```
Expire all silences matching a query
Expire all silences matching a query:
```
$ amtool silence query instance=~".+0"
ID Matchers Ends At Created By Comment
@ -280,20 +279,19 @@ $ amtool silence query instance=~".+0"
```
Expire all silences
Expire all silences:
```
$ amtool silence expire $(amtool silence query -q)
```
### Config
### Configuration
Amtool allows a config file to specify some options for convenience. The default config file paths are `$HOME/.config/amtool/config.yml` or `/etc/amtool/config.yml`
`amtool` allows a configuration file to specify some options for convenience. The default configuration file paths are `$HOME/.config/amtool/config.yml` or `/etc/amtool/config.yml`
An example configfile might look like the following:
An example configuration file might look like the following:
```
# Define the path that amtool can find your `alertmanager` instance at
alertmanager.url: "http://localhost:9093"
# Define the path that `amtool` can find your `alertmanager` instance at alertmanager.url: "http://localhost:9093"
# Override the default author. (unset defaults to your username)
author: me@example.com
@ -310,7 +308,7 @@ receiver: team-X-pager
### Routes
Amtool allows you to visualize the routes of your configuration in form of text tree view.
`amtool` allows you to visualize the routes of your configuration in form of text tree view.
Also you can use it to test the routing by passing it label set of an alert
and it prints out all receivers the alert would match ordered and separated by `,`.
(If you use `--verify.receivers` amtool returns error code 1 on mismatch)
@ -326,7 +324,7 @@ amtool config routes --alertmanager.url=http://localhost:9090
## High Availability
AlertManager's high availability is in production use at many companies and is enabled by default.
Alertmanager's high availability is in production use at many companies and is enabled by default.
> Important: Both UDP and TCP are needed in alertmanager 0.15 and higher for the cluster to work.
@ -378,18 +376,23 @@ alerting:
> Important: Do not load balance traffic between Prometheus and its Alertmanagers, but instead point Prometheus to a list of all Alertmanagers. The Alertmanager implementation expects all alerts to be sent to all Alertmanagers to ensure high availability.
### Disabling high availability
### Turn off high availability
If running Alertmanager in high availability mode is not desired, setting `--cluster.listen-address=` will prevent Alertmanager from listening to incoming peer requests.
If running Alertmanager in high availability mode is not desired, setting `--cluster.listen-address=` prevents Alertmanager from listening to incoming peer requests.
## Contributing to the Front-End
## Contributing
Refer to [ui/app/CONTRIBUTING.md](ui/app/CONTRIBUTING.md).
Check the [Prometheus contributing page](https://github.com/prometheus/prometheus/blob/master/CONTRIBUTING.md).
To contribute to the user interface, refer to [ui/app/CONTRIBUTING.md](ui/app/CONTRIBUTING.md).
## Architecture
![](doc/arch.svg)
## License
Apache License 2.0, see [LICENSE](https://github.com/prometheus/alertmanager/blob/master/LICENSE).
[hub]: https://hub.docker.com/r/prom/alertmanager/
[circleci]: https://circleci.com/gh/prometheus/alertmanager