mirror of
https://github.com/prometheus/alertmanager
synced 2025-03-01 17:20:51 +00:00
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>
119 lines
2.9 KiB
Go
119 lines
2.9 KiB
Go
package units
|
|
|
|
import (
|
|
"fmt"
|
|
"strconv"
|
|
"strings"
|
|
)
|
|
|
|
// Ulimit is a human friendly version of Rlimit.
|
|
type Ulimit struct {
|
|
Name string
|
|
Hard int64
|
|
Soft int64
|
|
}
|
|
|
|
// Rlimit specifies the resource limits, such as max open files.
|
|
type Rlimit struct {
|
|
Type int `json:"type,omitempty"`
|
|
Hard uint64 `json:"hard,omitempty"`
|
|
Soft uint64 `json:"soft,omitempty"`
|
|
}
|
|
|
|
const (
|
|
// magic numbers for making the syscall
|
|
// some of these are defined in the syscall package, but not all.
|
|
// Also since Windows client doesn't get access to the syscall package, need to
|
|
// define these here
|
|
rlimitAs = 9
|
|
rlimitCore = 4
|
|
rlimitCPU = 0
|
|
rlimitData = 2
|
|
rlimitFsize = 1
|
|
rlimitLocks = 10
|
|
rlimitMemlock = 8
|
|
rlimitMsgqueue = 12
|
|
rlimitNice = 13
|
|
rlimitNofile = 7
|
|
rlimitNproc = 6
|
|
rlimitRss = 5
|
|
rlimitRtprio = 14
|
|
rlimitRttime = 15
|
|
rlimitSigpending = 11
|
|
rlimitStack = 3
|
|
)
|
|
|
|
var ulimitNameMapping = map[string]int{
|
|
//"as": rlimitAs, // Disabled since this doesn't seem usable with the way Docker inits a container.
|
|
"core": rlimitCore,
|
|
"cpu": rlimitCPU,
|
|
"data": rlimitData,
|
|
"fsize": rlimitFsize,
|
|
"locks": rlimitLocks,
|
|
"memlock": rlimitMemlock,
|
|
"msgqueue": rlimitMsgqueue,
|
|
"nice": rlimitNice,
|
|
"nofile": rlimitNofile,
|
|
"nproc": rlimitNproc,
|
|
"rss": rlimitRss,
|
|
"rtprio": rlimitRtprio,
|
|
"rttime": rlimitRttime,
|
|
"sigpending": rlimitSigpending,
|
|
"stack": rlimitStack,
|
|
}
|
|
|
|
// ParseUlimit parses and returns a Ulimit from the specified string.
|
|
func ParseUlimit(val string) (*Ulimit, error) {
|
|
parts := strings.SplitN(val, "=", 2)
|
|
if len(parts) != 2 {
|
|
return nil, fmt.Errorf("invalid ulimit argument: %s", val)
|
|
}
|
|
|
|
if _, exists := ulimitNameMapping[parts[0]]; !exists {
|
|
return nil, fmt.Errorf("invalid ulimit type: %s", parts[0])
|
|
}
|
|
|
|
var (
|
|
soft int64
|
|
hard = &soft // default to soft in case no hard was set
|
|
temp int64
|
|
err error
|
|
)
|
|
switch limitVals := strings.Split(parts[1], ":"); len(limitVals) {
|
|
case 2:
|
|
temp, err = strconv.ParseInt(limitVals[1], 10, 64)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
hard = &temp
|
|
fallthrough
|
|
case 1:
|
|
soft, err = strconv.ParseInt(limitVals[0], 10, 64)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
default:
|
|
return nil, fmt.Errorf("too many limit value arguments - %s, can only have up to two, `soft[:hard]`", parts[1])
|
|
}
|
|
|
|
if soft > *hard {
|
|
return nil, fmt.Errorf("ulimit soft limit must be less than or equal to hard limit: %d > %d", soft, *hard)
|
|
}
|
|
|
|
return &Ulimit{Name: parts[0], Soft: soft, Hard: *hard}, nil
|
|
}
|
|
|
|
// GetRlimit returns the RLimit corresponding to Ulimit.
|
|
func (u *Ulimit) GetRlimit() (*Rlimit, error) {
|
|
t, exists := ulimitNameMapping[u.Name]
|
|
if !exists {
|
|
return nil, fmt.Errorf("invalid ulimit name %s", u.Name)
|
|
}
|
|
|
|
return &Rlimit{Type: t, Soft: uint64(u.Soft), Hard: uint64(u.Hard)}, nil
|
|
}
|
|
|
|
func (u *Ulimit) String() string {
|
|
return fmt.Sprintf("%s=%d:%d", u.Name, u.Soft, u.Hard)
|
|
}
|