mirror of
https://github.com/prometheus/alertmanager
synced 2024-12-25 07:32:19 +00:00
f1b920bcc9
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>
85 lines
3.0 KiB
Makefile
85 lines
3.0 KiB
Makefile
# Copyright 2015 The Prometheus Authors
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
include Makefile.common
|
|
|
|
FRONTEND_DIR = $(BIN_DIR)/ui/app
|
|
DOCKER_IMAGE_NAME ?= alertmanager
|
|
ERRCHECK_BINARY := $(FIRST_GOPATH)/bin/errcheck
|
|
|
|
ifdef DEBUG
|
|
bindata_flags = -debug
|
|
endif
|
|
|
|
STATICCHECK_IGNORE = \
|
|
github.com/prometheus/alertmanager/notify/notify.go:SA6002
|
|
|
|
|
|
.PHONY: build-all
|
|
# Will build both the front-end as well as the back-end
|
|
build-all: assets build
|
|
|
|
assets: go-bindata ui/bindata.go template/internal/deftmpl/bindata.go api/v2/models api/v2/restapi test/with_api_v2/api_v2_client/models test/with_api_v2/api_v2_client/client
|
|
|
|
go-bindata:
|
|
-@$(GO) get -u github.com/jteeuwen/go-bindata/...
|
|
|
|
template/internal/deftmpl/bindata.go: template/default.tmpl
|
|
@go-bindata $(bindata_flags) -mode 420 -modtime 1 -pkg deftmpl -o template/internal/deftmpl/bindata.go template/default.tmpl
|
|
@$(GO) fmt ./template/internal/deftmpl
|
|
|
|
ui/bindata.go: ui/app/script.js ui/app/index.html ui/app/lib
|
|
# Using "-mode 420" and "-modtime 1" to make assets make target deterministic.
|
|
# It sets all file permissions and time stamps to 420 and 1
|
|
@go-bindata $(bindata_flags) -mode 420 -modtime 1 -pkg ui -o \
|
|
ui/bindata.go ui/app/script.js \
|
|
ui/app/index.html \
|
|
ui/app/favicon.ico \
|
|
ui/app/lib/...
|
|
@$(GO) fmt ./ui
|
|
|
|
ui/app/script.js: $(shell find ui/app/src -iname *.elm)
|
|
cd $(FRONTEND_DIR) && $(MAKE) script.js
|
|
|
|
.PHONY: proto
|
|
proto:
|
|
scripts/genproto.sh
|
|
|
|
SWAGGER = docker run \
|
|
--user=$(shell id -u $(USER)):$(shell id -g $(USER)) \
|
|
--rm \
|
|
-v $(shell pwd):/go/src/github.com/prometheus/alertmanager \
|
|
-w /go/src/github.com/prometheus/alertmanager quay.io/goswagger/swagger:0.16.0
|
|
|
|
api/v2/models api/v2/restapi: api/v2/openapi.yaml
|
|
-rm -r api/v2/{models,restapi}
|
|
$(SWAGGER) generate server -f api/v2/openapi.yaml --exclude-main -A alertmanager --target api/v2/
|
|
|
|
test/with_api_v2/api_v2_client/models test/with_api_v2/api_v2_client/client: api/v2/openapi.yaml
|
|
-rm -r test/with_api_v1/api_v2_client; mkdir -p test/with_api_v2/api_v2_client
|
|
$(SWAGGER) generate client -f api/v2/openapi.yaml --target test/with_api_v2/api_v2_client
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm template/internal/deftmpl/bindata.go
|
|
rm ui/bindata.go
|
|
cd $(FRONTEND_DIR) && $(MAKE) clean
|
|
|
|
.PHONY: test
|
|
test: common-test $(ERRCHECK_BINARY)
|
|
@echo ">> running errcheck with exclude file scripts/errcheck_excludes.txt"
|
|
$(ERRCHECK_BINARY) -verbose -exclude scripts/errcheck_excludes.txt -ignoretests ./...
|
|
|
|
$(ERRCHECK_BINARY):
|
|
@go get github.com/kisielk/errcheck
|