ertx-krueger.1.1.0.source-code.operations-swagger.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-krueger Show documentation
Show all versions of vertx-krueger Show documentation
This library creates vertx web endpoints exposing application metrics that can be consumed by Krueger (https://github.com/zalando/krueger-cockpit)
{
"swagger": "2.0",
"info": {
"title": "Vertx Krueger API for operations",
"description": "This is the API for operating the component",
"version": "0.0.1"
},
"produces": [
"application/json"
],
"paths": {
"/health": {
"get": {
"summary": "Returns the health status of an application - 'ok' string if application is up.",
"responses": {
"200": {
"description": "Health",
"schema": {
"type": "string"
}
}
}
}
},
"/metrics": {
"get": {
"summary": "Returns the collected metrics for the components endpoints.",
"responses": {
"200": {
"description": "Metrics",
"schema": {
"type": "object"
}
}
}
}
},
"/metrics/statusCodes": {
"get": {
"summary": "Returns histograms for the distribution of status codes per endpoint.",
"responses": {
"200": {
"description": "Metrics",
"schema": {
"type": "object"
}
}
}
}
},
"/metrics/vertx": {
"get": {
"summary": "Returns the collected metrics for vertx.",
"responses": {
"200": {
"description": "Metrics",
"schema": {
"type": "object"
}
}
}
}
},
"/metrics/eventBus": {
"get": {
"summary": "Returns the collected metrics for the vertx event bus.",
"responses": {
"200": {
"description": "Metrics",
"schema": {
"type": "object"
}
}
}
}
},
"/env": {
"get": {
"summary": "Returns the environment variables",
"responses": {
"200": {
"description": "Environment variables",
"schema": {
"type": "object"
}
}
}
}
},
"/properties": {
"get": {
"summary": "Returns the system properties",
"responses": {
"200": {
"description": "System properties",
"schema": {
"type": "object"
}
}
}
}
}
}
}