Commit Graph

71 Commits

Author SHA1 Message Date
Adam Shannon 4440caa94e docs: clarify API routing (and with --web.route-prefix)
Signed-off-by: Adam Shannon <adamkshannon@gmail.com>
2019-06-11 12:35:57 -05:00
JoeWrightss 5c61f4dbc8 Fixs typo in README.md (#1687)
Signed-off-by: zhoulin xie <zhoulin.xie@daocloud.io>
2019-02-01 16:49:57 +01:00
Hrishikesh Barman 78914f868d added documentation (#1654)
* ref #1610 : added documentation

Signed-off-by: Hrishikesh Barman <hrishikeshbman@gmail.com>
2018-12-08 12:05:47 +01:00
kirillsablin 32bb289906 dispatch: Add group_by_all support (#1588)
To aggregate by all possible labels use '...' as the sole label name. 
This effectively disables aggregation entirely, passing through all 
alerts as-is. This is unlikely to be what you want, unless you have 
a very low alert volume or your upstream notification system performs 
its own grouping. Example: group_by: [...]

Signed-off-by: Kyryl Sablin <kyryl.sablin@schibsted.com>
2018-11-29 12:31:14 +01:00
Kai S d593562493 Make a note about the firewall in HA mode (#1563)
* Make a note about the firewall in HA mode
2018-10-01 13:39:50 +02:00
dseebacher d5b8e10286 Fix the Swagger/OpenAPI link (#1552)
Signed-off-by: David Seebacher <dseebacher@gmail.com>
2018-09-18 13:47:21 +02:00
Simon Pasquier 47c84402af README.md: update HA section
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2018-09-07 10:36:42 +02:00
Max Leonard Inden f1b920bcc9
api: Implement OpenAPI generated Alertmanager API V2
The current Alertmanager API v1 is undocumented and written by hand.
This patch introduces a new Alertmanager API - v2. The API is fully
generated via an OpenAPI 2.0 [1] specification (see
`api/v2/openapi.yaml`) with the exception of the http handlers itself.

Pros:
- Generated server code
- Ability to generate clients in all major languages
  (Go, Java, JS, Python, Ruby, Haskell, *elm* [3] ...)
    - Strict contract (OpenAPI spec) between server and clients.
    - Instant feedback on frontend-breaking changes, due to strictly
      typed frontend language elm.
- Generated documentation (See Alertmanager online Swagger UI [4])

Cons:
- Dependency on open api ecosystem including go-swagger [2]

In addition this patch includes the following changes.

- README.md: Add API section

- test: Duplicate acceptance test to API v1 & API v2 version

  The Alertmanager acceptance test framework has a decent test coverage
  on the Alertmanager API. Introducing the Alertmanager API v2 does not go
  hand in hand with deprecating API v1. They should live alongside each
  other for a couple of minor Alertmanager versions.

  Instead of porting the acceptance test framework to use the new API v2,
  this patch duplicates the acceptance tests, one using the API v1, the
  other API v2.

  Once API v1 is removed we can simply remove `test/with_api_v1` and bring
  `test/with_api_v2` to `test/`.

[1]
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

[2] https://github.com/go-swagger/go-swagger/

[3] https://github.com/ahultgren/swagger-elm

[4]
http://petstore.swagger.io/?url=https://raw.githubusercontent.com/mxinden/alertmanager/apiv2/api/v2/openapi.yaml

Signed-off-by: Max Leonard Inden <IndenML@gmail.com>
2018-09-04 13:38:34 +02:00
Martin Chodur 5d222bce55 feat: added routing tools to amtool (#1511)
Signed-off-by: Martin Chodur <m.chodur@seznam.cz>
2018-08-22 16:41:09 +02:00
Kellen Fox b949f0dc19 Amtool: Implement filter by receiver fixes:#937 (#1402)
* Amtool: Implement filter by receiver

* Adds receiver flag to amtool alert query
* Adds receiver argument to alert http client
* Updates http client tests for added argument

Also works: scpecifying `receiver: "receiver-123"` in config file
automaticly filters all alerts shown

* Include receiver in amtool config docs

Now that I've implemented the receiver in amtool I should add the new
feature to the documentation.

*  #937 Add mention of supporting regex syntax to receiver flag
2018-06-07 09:21:12 +02:00
Silvio Gissi 402564055b Update Architecture diagram (#1394)
* Update Architecture diagram

Update diagram from sketch to vector.
Add draw.io XML source file.
Update README.md to display master doc/arch.jpg

Signed-off-by: Silvio Gissi <silvio@gissilabs.com>

* Updated README.md with relative link to architecture doc.

* Updated Architecture document from JPG to SVG

Signed-off-by: Silvio Gissi <silvio@gissilabs.com>

* Small fix in graph.

* Updated font to align with Prometheus architecture.

Signed-off-by: Silvio Gissi <silvio@gissilabs.com>

* Embedded images at arch.svg

* Removed images from SVG, update source XML
2018-05-31 15:34:52 +02:00
rhysm e4416bd612 Add additional cluster configuration flags (#1379)
The cluster configuration uses DefaultLANConfig which seems
to be quite sensitive to WAN conditions. Allowing the tuning of these 3
parameters (TCP Timeout, Probe Interval and Probe Timeout) makes
clustering more robust across WAN connections.

Signed-off-by: Rhys Meaclem <rhysmeaclem@gmail.com>
2018-05-14 09:22:04 +02:00
James Turnbull 6ebfb88cbc Update for new HA docs (#1277)
* Update for new HA

* Fixed default

* Added cluster settle reference
2018-03-07 14:08:35 +01:00
Calle Pettersson b7da058efb Switch cmd/alertmanager to kingpin (#974) 2018-01-06 11:22:26 +01:00
anthraxn8b 2a0989094b Added 2nd email address to “to“ field (#1163)
Did this to give an example with multiple email addresses in the “to“ field.
2017-12-22 00:14:23 +01:00
James Turnbull 7d795d8c03 Updated README for Prometheus 2.x (#1134) 2017-12-10 15:49:31 +00:00
Binh Le fa17eb4b00 amtool - fix typo in README for comment_required config (#1100)
It is 'comment_required' in code:
https://github.com/prometheus/alertmanager/blob/master/cli/silence_add.go#L118
2017-11-16 11:22:00 -05:00
Steven Carvellas 5db8055bab Add support for PagerDuty API v2 (#1054) 2017-11-07 11:07:27 +01:00
Callum Styan 1eef24cae2 add readme note about optional build binaries 2017-09-12 14:18:06 -07:00
Kellen Fox eb38b469f1 Provide README information for amtool (#939)
* Provide README information for amtool

Amtool has been bundled with alertmanager for a while now. It's probably
far past the acceptable time to add information to the readme

* Fixups based on recommendations

* replace `,` with `.` in first sentance
* Add silence query example with filtering
* Add silence add example with multiple matchers and a regex
* Add silence expire all example that shows query -q
* Add configfile example
2017-08-22 18:13:40 -05:00
Max Inden 0819ee8a87 Update build status to target master (#826)
Instead of targeting the latest build, which could be any PR, we should target current master results.
2017-05-28 13:25:17 +02:00
Max Inden f298a21e97 Sync master (#791)
* Anchor silence regex rules

When user creates a new silence with regex match it's left to the user to anchor it, which is not consistent with Prometheus regex handling (promql/functions.go#L818).

* Serialize AlertStatus as 'status'

AlertStatus doesn't have json tag with the field name, so it's serialized into 'Status', and it's the only uppercase field in the alert object. Tag it with 'status' name for consistency

* Fix lock usage in the types package

Locking is a bit tricky there since some state-modifying methods will call to other methods that also modify marker state, simple defer won't work.

* Throw error when continue in route root of Alertmanager config

* Fix alert status handling in UI

* Fixes #746

Found that we are only defining MarshalJSON for the Regexp type for
references not for the direct object

Also took the time to simplify the json.Unmarshal usage in cli/config.go

* Added unit test for continue in root route error (#768)

* Added unit test for continue in root route error

* replaced %v with %q

* Fix broken link to silence from alert

* Fix broken link to silence from alert

* *: cut v0.6.2 (#777)

* Show startsAt time for pending silences (#778)

* docs: Add note to not load balance Alert trafic
2017-05-12 13:46:11 +02:00
stuart nelson 4288292365 Add CONTRIBUTING.md for front-end code 2017-03-31 17:49:50 +02:00
stuart nelson 412d33336d Update README.md (#641)
Make it more clear that -mesh.peer flag should be
repeated for each peer.
2017-03-02 12:35:04 +01:00
stuart nelson 24a9a64bdf Only find MAC address if no command-line flag value given (#638)
* Find MAC address if mesh.hardware-addr not given

Defaulting to the machine's MAC address fails
sometimes fails and causes a panic. Allow the user
to specify custom address to skip this so they can
run AlertManager.

* -mesh.hardware-address -> -mesh.peer-id

* Fix command-line invocation
2017-02-28 14:57:45 +01:00
Vladimir Pouzanov ab831348f1 Fixed the go install command (#513) 2016-09-25 13:34:13 +02:00
Frederic Branczyk b901ea8192 add HA documentation to README.md 2016-09-09 15:28:32 +02:00
Fabian Reinartz d0c574d318 readme: point to prometheus.io download section 2016-09-07 14:30:57 +02:00
Fabian Reinartz 4ec5208da4 Update README
This removes some things that no longer apply and syncs the installation intructions with the Prometheus repository
2016-09-06 17:00:52 +02:00
Fabian Reinartz 11b9061ffb readme: update config documentation link 2016-06-14 11:03:49 +02:00
Steve Durrheimer a1ce2e3383
Update README image shields 2016-05-13 21:48:57 +02:00
Steve Durrheimer 9d4dccae7c
New release process using docker, circleci and a centralized
building tool
2016-04-22 21:46:53 +02:00
Max Chadwick 4cb3874ab8 Move SMTP auth to the config file 2016-04-16 16:41:55 -04:00
Max Chadwick eaff66916c Clarify SMTP authentication in the docs 2016-04-10 21:25:06 -04:00
Julius Volz a540be82a2 Clarify build- vs. run-time dependencies in README.md
See https://github.com/prometheus/alertmanager/issues/285
2016-03-30 16:05:42 +02:00
Fabian Reinartz 1494104e56 Remove development status from release version 2016-03-01 11:14:01 +01:00
Fabian Reinartz 078d5d17e6 Remove 'pending issues' from released version. 2016-03-01 11:12:51 +01:00
Fabian Reinartz 94d868d2de Add proper short description and link to docs 2016-02-23 17:12:19 +01:00
cherti 8514db159f fix build command
`make` alone doesn't work to build alertmanager, throws a pile of errors instead here. `make build` works perfectly fine, though.
2016-02-02 10:27:20 +01:00
Fabian Reinartz edcc8aea78 Remove continue clauses from example config
The continue examples were not aligned with the current semantics and
are mostly important for advanced use cases. Those are not in the scope
of this basic example.
2016-01-28 14:03:36 +01:00
Fabian Reinartz 983e5db56c Update example configuration 2016-01-28 14:02:15 +01:00
Johannes 'fish' Ziemke 83b9913dae Fix typo in README 2016-01-28 13:25:09 +01:00
Fabian Reinartz 5d96e6cb6d Remove fixed TODO item 2016-01-21 14:19:39 +01:00
Richard Hartmann 27bbdf333d README.md: sudo ALL the yums 2016-01-08 14:59:32 +01:00
Fabian Reinartz 4540c75887 Remove template section from example config
Since our default templates are now compiled into the binary, this is only
relevant to advanced users and will cause trouble when running a derivative
of the example config within the repository directory.
2016-01-07 16:19:51 +01:00
Richard Hartmann fcf17c2ee4 README.md: List dependencies 2016-01-07 15:15:21 +01:00
beorn7 93ffa534a5 PR with changes after code review
Now to be reverse-reveiewed.
2015-11-23 18:24:57 +01:00
Fabian Reinartz dc656a44ea Adjust config fields to 'receiver' 2015-11-10 14:08:20 +01:00
Fabian Reinartz a1c7c49a91 Remove resolved issues 2015-11-10 11:26:42 +01:00
Fabian Reinartz ff514dbf06 Embed architecture sketch in README 2015-10-26 15:11:14 +01:00