Skip to content

Commit d1d0dd0

Browse files
committed
Send AlertManager notifications to Elasticsearch
Add a new service, `alertmanager2es`, which receives [HTTP webhook notifications][] from [AlertManager][] and inserts them into an [Elasticsearch][] index for searching and analysis. Notifications are received on the `/webhook` endpoint. Prometheus metrics are exposed on `/metrics`. Note that this service will not capture silenced or inhibited alerts currently. I used a custom type for `groupKey` so that the `groupKey` field can be marshalled into JSON as a string, since Elasticsearch does not currently support unsigned integers: elastic/elasticsearch#13951 I tested extensively to try to map the integer to a string using Elasticsearch's mappings, which I succeeded in doing, however Kibana then failed to display the documents because Elasticsearch's highlighting could not handle the unsigned integer stored in `_source`: RemoteTransportException[[Eternal Brain][172.17.0.2:9300][indices:data/read/search[phase/query+fetch]]]; nested: FetchPhaseExecutionException[Fetch Failed [Failed to highlight field [alerts.labels.decoded_pem_md5]]]; nested: IllegalStateException[No matching token for number_type [BIG_INTEGER]]; Caused by: FetchPhaseExecutionException[Fetch Failed [Failed to highlight field [alerts.labels.decoded_pem_md5]]]; nested: IllegalStateException[No matching token for number_type [BIG_INTEGER]]; at org.elasticsearch.search.highlight.PlainHighlighter.highlight(PlainHighlighter.java:123) at org.elasticsearch.search.highlight.HighlightPhase.hitExecute(HighlightPhase.java:140) at org.elasticsearch.search.fetch.FetchPhase.execute(FetchPhase.java:188) at org.elasticsearch.search.SearchService.executeFetchPhase(SearchService.java:490) at org.elasticsearch.search.action.SearchServiceTransportAction$SearchQueryFetchTransportHandler.messageReceived(SearchServiceTransportAction.java:392) at org.elasticsearch.search.action.SearchServiceTransportAction$SearchQueryFetchTransportHandler.messageReceived(SearchServiceTransportAction.java:389) at org.elasticsearch.transport.TransportRequestHandler.messageReceived(TransportRequestHandler.java:33) at org.elasticsearch.transport.RequestHandlerRegistry.processMessageReceived(RequestHandlerRegistry.java:77) at org.elasticsearch.transport.TransportService$4.doRun(TransportService.java:376) at org.elasticsearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:37) at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) at java.lang.Thread.run(Thread.java:745) The dependencies for this code are vendored using gvt. [AlertManager]: https://github.com/prometheus/alertmanager [Elasticsearch]: https://www.elastic.co/products/elasticsearch [HTTP webhook]: https://prometheus.io/docs/alerting/configuration/#webhook-receiver-<webhook_config>
0 parents  commit d1d0dd0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+22841
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing to alertmanager2es
2+
3+
Contributions are welcomed.
4+
5+
## Getting started
6+
7+
To download, run:
8+
9+
go get -u github.com/cloudflare/alertmanager2es
10+
11+
To run the tests:
12+
13+
make test

LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Makefile

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.PHONY: build test
2+
3+
build: test
4+
go build -ldflags "-X main.revision=$(git describe --tags --always --dirty='-dev')"
5+
6+
test:
7+
go test $(go list ./... | grep -v /vendor/)

README.md

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
# alertmanager2es
2+
3+
alertmanager2es receives [HTTP webhook][] notifications from [AlertManager][]
4+
and inserts them into an [Elasticsearch][] index for searching and analysis. It
5+
runs as a daemon.
6+
7+
The alerts are stored in Elasticsearch as [alert groups][].
8+
9+
[alert groups]: https://prometheus.io/docs/alerting/alertmanager/#grouping
10+
[AlertManager]: https://github.com/prometheus/alertmanager
11+
[Elasticsearch]: https://www.elastic.co/products/elasticsearch
12+
[HTTP webhook]: https://prometheus.io/docs/alerting/configuration/#webhook-receiver-<webhook_config>
13+
14+
## Rationale
15+
16+
It can be useful to see which alerts fired over a given time period, and
17+
perform historical analysis of when and where alerts fired. Having this data
18+
can help:
19+
20+
- tune alerting rules
21+
- understand the impact of an incident
22+
- understand which alerts fired during an incident
23+
24+
It might have been possible to configure Alertmanager to send the alert groups
25+
to Elasticsearch directly, if not for the fact that [Elasticsearch][] [does not
26+
support unsigned integers][] at the time of writing. Alertmanager uses an
27+
unsigned integer for the `groupKey` field, which alertmanager2es converts to a
28+
string.
29+
30+
[does not support unsigned integers]: https://github.com/elastic/elasticsearch/issues/13951
31+
32+
## Limitations
33+
34+
- alertmanager2es will not capture [silenced][] or [inhibited][] alerts; the alert
35+
notifications stored in Elasticsearch will closely resemble the notifications
36+
received by a human.
37+
38+
[silenced]: https://prometheus.io/docs/alerting/alertmanager/#silences
39+
[inhibited]: https://prometheus.io/docs/alerting/alertmanager/#inhibition
40+
41+
- Kibana does not display arrays of objects well (the alert groupings use an
42+
array), so you may find some irregularities when exploring the alert data in
43+
Kibana. We have not found this to be a significant limitation, and it is
44+
possible to query alert labels stored within the array.
45+
46+
## Prerequisites
47+
48+
To use alertmanager2es, you'll need:
49+
50+
- an [Elasticsearch][] cluster
51+
- [Alertmanager][]
52+
53+
To build alertmanager2es, you'll need:
54+
55+
- [Make][]
56+
- [Go][] 1.7 or above
57+
- a working [GOPATH][]
58+
59+
[Make]: https://www.gnu.org/software/make/
60+
[Go]: https://golang.org/dl/
61+
[GOPATH]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
62+
63+
## Building
64+
65+
go get -u github.com/cloudflare/alertmanager2es
66+
make
67+
68+
## Configuration
69+
70+
### alertmanager2es usage
71+
72+
alertmanager2es is configured using commandline flags. It is assumed that
73+
alertmanager2es has unrestricted access to your Elasticsearch cluster.
74+
75+
alertmanager2es does not perform any user authentication.
76+
77+
Run `./alertmanager2es -help` to view the configurable commandline flags.
78+
79+
### Example Alertmanager configuration
80+
81+
#### Receiver configuration
82+
83+
```yaml
84+
- name: alertmanager2es
85+
webhook_configs:
86+
- url: https://alertmanager2es.example.com/webhook
87+
```
88+
89+
#### Route configuration
90+
91+
By omitting a matcher, this route will match all alerts:
92+
93+
```yaml
94+
- receiver: alertmanager2es
95+
continue: true
96+
```
97+
98+
### Example Elasticsearch template
99+
100+
Apply this Elasticsearch template before you configure alertmanager2es to start
101+
sending data:
102+
103+
```json
104+
{
105+
"template": "alertmanager-2*",
106+
"settings": {
107+
"number_of_shards": 1,
108+
"number_of_replicas": 1,
109+
"index.refresh_interval": "10s",
110+
"index.query.default_field": "groupLabels.alertname"
111+
},
112+
"mappings": {
113+
"_default_": {
114+
"_all": {
115+
"enabled": false
116+
},
117+
"properties": {
118+
"@timestamp": {
119+
"type": "date",
120+
"doc_values": true
121+
}
122+
},
123+
"dynamic_templates": [
124+
{
125+
"string_fields": {
126+
"match": "*",
127+
"match_mapping_type": "string",
128+
"mapping": {
129+
"type": "string",
130+
"index": "not_analyzed",
131+
"ignore_above": 1024,
132+
"doc_values": true
133+
}
134+
}
135+
}
136+
]
137+
}
138+
}
139+
}
140+
```
141+
142+
We rotate our index once a month, since there's not enough data to warrant
143+
daily rotation in our case. Therefore our index name looks like:
144+
145+
alertmanager-200601
146+
147+
We anchor the template name with `-2` to avoid inadvertently matching other
148+
indices, e.g. `alertmanager-foo-200601`. This of course assumes that you will
149+
no longer care to index your alerts in the year 3000.
150+
151+
## Failure modes
152+
153+
alertmanager2es will return a HTTP 500 (Internal Server Error) if it encounters
154+
a non-2xx response from Elasticsearch. Therefore if Elasticsearch is down,
155+
alertmanager2es will respond to Alertmanager with a HTTP 500. No retries are
156+
made as Alertmanager has its own retry logic.
157+
158+
Both the HTTP server exposed by alertmanager2es and the HTTP client that
159+
connects to Elasticsearch have read and write timeouts of 10 seconds.
160+
161+
## Metrics
162+
163+
alertmanager2es exposes [Prometheus][] metrics on `/metrics`.
164+
165+
[Prometheus]: https://prometheus.io/
166+
167+
## Example Elasticsearch queries
168+
169+
alerts.labels.alertname:"Disk_Likely_To_Fill_Next_4_Days"
170+
171+
## Contributions
172+
173+
Pull requests, comments and suggestions are welcome.
174+
175+
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)