github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Add v1 to metrics API endpoint

Browse Source 
Fixes #1399

This versions the prometheus metrics API so we can manage backwards
incompatible changes in the future more easily.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
This commit is contained in:
Michael Crosby
2017-09-20 16:24:30 -04:00
parent 9934acb271
commit f23edd3cc0
3 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
RELEASES.md
View File

@@ -189,6 +189,15 @@ enumerating the support services and messages. See [api/](api) for details.
Note that new services may be added in _minor_ releases. New service methods
and new fields on messages may be added if they are optional.
### Metrics API
The metrics API that outputs prometheus style metrics will be versioned independently,
prefixed with the API version. i.e. `/v1/metrics`, `/v2/metrics`.
The metrics API version will be incremented when breaking changes are made to the prometheus
output. New metrics can be added to the output in a backwards compatible manner without
bumping the API version.
#### Error Codes
Error codes will not change in a patch release, unless a missing error code