Prometheus API (0.4.2)

Download OpenAPI specification:Download

Hayk Davtyan: hayko5999@gmail.com URL: https://hayk96.github.io License: MIT License

This project enhances the native Prometheus HTTP API by providing additional features and addressing its limitations. Running as a sidecar alongside the Prometheus server enables users to extend the capabilities of the API.

metrics

Metrics

Endpoint that serves Prometheus metrics.

Responses

Response samples

200

Content type

application/json

null

rules

Create Rule

Creates a new rule with a randomly generated filename

Request Body schema: application/json

file	string (File) Default: ""
data	object (Data) Default: {}

Responses

Request samples

Payload

Content type

application/json

Example

Creates Prometheus recording rule with the name ExampleRecordingRule

{"data": {"groups": [{"name": "ExampleRecordingRule",
"rules": [{"record": "code:prometheus_http_requests_total:sum",
"expr": "sum by (code) (prometheus_http_requests_total)"
}
]
}
]
}
}

Response samples

201
400
422
500

Content type

application/json

[{"status": "success",
"file": "example-rule.yml",
"message": "The rule was created successfully"
}
]

Create Rule

Creates a new rule file with the provided filename

path Parameters

file

required

string (File)

query Parameters

recreate

string (Recreate)

Default: "false"

Request Body schema: application/json

file	string (File) Default: ""
data	object (Data) Default: {}

Responses

Request samples

Payload

Content type

application/json

Example

Creates Prometheus recording rule with the name ExampleRecordingRule

{"data": {"groups": [{"name": "ExampleRecordingRule",
"rules": [{"record": "code:prometheus_http_requests_total:sum",
"expr": "sum by (code) (prometheus_http_requests_total)"
}
]
}
]
}
}

Response samples

201
400
409
422
500

Content type

application/json

[{"status": "success",
"message": "The rule was created successfully"
}
]

Delete Rule

Deletes a rule that matches to the provided parameter

path Parameters

file

required

any (File)

Responses

Response samples

404
422
500

Content type

application/json

[{"status": "error",
"message": "File not found"
}
]

export

Export Data From Prometheus

Exports data from Prometheus based on the provided PromQL

query Parameters

format

string (Format)

Default: "csv"

Request Body schema: application/json

expr required	string (Expr)
start	string (Start)
end	string (End)
step	string (Step)
timestamp_format	string (Timestamp Format) Default: "unix"
replace_fields	object (Replace Fields) Default: {}

Responses

Request samples

Payload

Content type

application/json

Example

Count of successful logins by users per hour in a day

{"expr": "users_login_count{status='success'}",
"start": "2024-01-30T00:00:00Z",
"end": "2024-01-31T23:59:59Z",
"step": "1h"
}

Response samples

200
400
422
500

Content type

null

metrics-lifecycle-policies

Get Metrics Lifecycle Policy By Name

Returns metrics lifecycle policy that match the provided name parameter

path Parameters

name

required

string (Name)

Responses

Response samples

200
404
422

Content type

application/json

[{"match": "{__name__=~'go_.*'}",
"keep_for": "7d",
"description": "This metrics lifecycle policy keeps GoLang metrics for 7 days"
}
]

Delete Metrics Lifecycle Policy

Deletes specific metrics lifecycle policy

path Parameters

name

required

string (Name)

Responses

Response samples

404
422
500

Content type

application/json

[{"status": "error",
"message": "Policy not found"
}
]

Update Metrics Lifecycle Policy By Name

Updates specific metrics lifecycle policy

path Parameters

name

required

string (Name)

Request Body schema: application/json

pattern	string (Pattern)
keep_for	string (Keep For)
description	string (Description)

Responses

Request samples

Payload

Content type

application/json

Example

Updates keep_for setting only

{"keep_for": "10d"
}

Response samples

200
400
404
422
500

Content type

application/json

[{"status": "success",
"message": "Policy updated successfully"
}
]

Get All Metrics Lifecycle Policies

Returns all metrics lifecycle policies

Responses

Response samples

200

Content type

application/json

[{"GoLang Policy": {"match": "{__name__=~'go_.*'}",
"keep_for": "7d",
"message": "This policy keeps GoLang metrics for 7 days"
},
"Kubernetes Policy": {"match": "{job='kubernetes-pods'}",
"keep_for": "10d",
"message": "This policy keeps series of job 'kubernetes-pods' for 10 days"
}
}
]

Create Metrics Lifecycle Policy

Creates a new metrics lifecycle policy

Request Body schema: application/json

name required	string (Name)
match required	string (Match)
keep_for required	string (Keep For)
description	string (Description)

Responses

Request samples

Payload

Content type

application/json

Time-series matching with regex will be kept for 7 days

{"name": "Example Policy",
"match": "{__name__=~'go_.*'}",
"keep_for": "7d",
"description": "Time-series matching with regex will be kept for 7 days."
}

Response samples

201
400
409
422
500

Content type

application/json

[{"status": "success",
"policy_name": "GoLang Metrics Policy",
"message": "Policy created successfully"
}
]

Trigger Metrics Lifecycle Policies

Force triggers all new metrics lifecycle policies

Responses

Response samples

202
409

Content type

application/json

[{"status": "success",
"message": "Your request has been accepted for processing"
}
]

health

Get System Health

Returns a 200 status when the prometheus-api is able to connect to the Prometheus server

Responses

Response samples

200
503

Content type

application/json

[{"status": "success",
"message": "Service is up and running"
}
]