Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Latest commit

 

History

History
103 lines (69 loc) · 5.92 KB

CHANGELOG.md

File metadata and controls

103 lines (69 loc) · 5.92 KB

Changelog

0.5.1 / 2024-12-07

  • [BUGFIX] Fixed JSON schema validations for configuration management API. #59

0.5.0 / 2024-12-06

  • [REFACTOR] Created a PrometheusAPIClient class for core API functionalities such as creating/deleting rule files and updating/reloading configurations. Removed a duplicated validation function and moved it to the utils folder. Also Updated the architecture diagram. #53
  • [ENHANCEMENT] Introduced a new web page called Config Management for managing Prometheus configuration through a web interface. This page utilizes the /configs API. #52
  • [ENHANCEMENT] Introduces a new API /configs for Prometheus configuration (prometheus.yml). This API provides three methods: GET, PUT, and PATCH:
    • Fetch the existing configuration in JSON or YAML format.
    • Update the entire Prometheus configuration file.
    • Partially update specific sections of the configuration file. Adds an OpenAPI specification for the prometheus.yml #51
  • [CHANGE] The name of the page API Documentation has been renamed to API Reference. Changed server address in API reference page. #50

0.4.2 / 2024-07-05

  • [CHANGE] Replaced base64 encoded files in web assets (HTML, CSS) with common images and added a new route for images.

0.4.1 / 2024-06-30

  • [ENHANCEMENT] Added a new web page for reports. This page allows exporting Prometheus data in various formats directly from the web UI. #43
  • [ENHANCEMENT] Added functionality to change the timestamp format while exporting data via the /export API. Previously, the default value was Unix timestamp. Now, you can choose from the following options: iso8601, rfc2822, rfc3339, friendly, and unix (default). #41
  • [ENHANCEMENT] Added a new feature that allows replacing Prometheus labels (fields) in the final dataset: CSV, JSON, etc. #39
  • [ENHANCEMENT] Added support for exporting files in multiple formats via the /export API. Supported formats include: CSV, YAML (or YML), JSON, and JSON Lines (or NDJSON). E.g., ?format=csv|yaml|yml|json|ndjson|jsonlines. #37
  • [BUGFIX] Fixed the functionality that generates CSV files to ensure they have unique names instead of static names, resolving issues with responses getting mixed up between users. #35
  • [BUGFIX] Fixed exception handling for replace_fields in the /export API. #43

0.4.0 / 2024-06-23

  • [ENHANCEMENT] Added a new API endpoint: /export for exporting data from Prometheus as a CSV file. This feature allows users to export data from Prometheus easily. It supports both instant queries and range queries. More details can be found in the API documentation. #33

0.3.3 / 2024-06-16

  • [ENHANCEMENT] Added a new endpoint: /metrics-lifecycle-policies/trigger for force-triggering all Metrics Lifecycle Policies. #29
  • [CHANGE] Changed the execution interval of the task "Clean-up Prometheus series" by the scheduler to 2 hours (previously 20 minutes).
  • [BUGFIX] Prevented the execution of more than one task at the same time, as tasks can remain in the running state for longer than their execution interval.

0.3.2 / 2024-06-08

  • [ENHANCEMENT] Added a new endpoint: /health for retrieving system health. #28
  • [ENHANCEMENT] Added a new function that continuously checks (600 checks at 3-second intervals) for establishing a connection to Prometheus.
  • [BUGFIX] The Prometheus /runtimeinfo API call check has been moved under the validation function.
  • [BUGFIX] Added proper exception handling while checking the status of the reload API of Prometheus at runtime.

0.3.1 / 2024-06-01

  • [ENHANCEMENT] Added a new webpage, Metrics Management, based on the /metrics-lifecycle-policies API. This feature allows for directly defining and managing policies for retaining Prometheus metrics. #23
  • [ENHANCEMENT] Added support for dark mode on the Rules Management page. #16
  • [ENHANCEMENT] Added support of filtering of rules by their type from the UI. #15

0.3.0 / 2024-05-26

  • [ENHANCEMENT] Introduced a new API /metrics-lifecycle-policies for managing metrics lifecycle in the Prometheus ecosystem. This flexible API allows users to define policies that specify which time-series should be retained and for how long in the Prometheus TSDB storage.
  • [BUGFIX] fixed description of 404 status code of the DELETE /api/v1/rules API in the Redocli page.

0.2.2 / 2024-05-12

  • [REVERT] Reverted schema validation mechanism of rules API. Use local schema validation instead of remote which was introduces in v0.1.2. #18

0.2.1 / 2024-05-07

  • [CHANGE] Serve remote JS script through Cloudflare CDN. No API changes. #17

0.2.0 / 2024-05-02

  • [ENHANCEMENT] Added support of Web UI for better management of the Prometheus rules through UI. #14
  • [CHANGE] Updated documentation

0.1.5 / 2024-02-25

  • [ENHANCEMENT] Added support for exposing Prometheus metrics. The corresponding metrics are available under the path /api-metrics. The /metrics endpoint is also accessible for exposing the metrics of the Prometheus server.
  • [BUGFIX] Fixed startup check of filesystem permissions in case of OSError.

0.1.4 / 2024-01-28

  • [ENHANCEMENT] Added HTTP query string: recreate=true|false for PUT /api/v1/rules/{file} endpoint.
  • [CHANGE] Log format includes HTTP query strings passed by user.

0.1.3 / 2024-01-21

  • [CHANGE] Upgraded FastAPI module from 0.95.1 to 0.109.0.
  • [ENHANCEMENT] Updated OpenAPI reference
  • [ENHANCEMENT] Support auto-generation of OpenAPI specification
  • [ENHANCEMENT] Added API documentation page (powered by Redocly) which is available here: https://hayk96.github.io/prometheus-api.

0.1.2 / 2023-11-18

  • [ENHANCEMENT] Use remote schema for Prometheus rule #7

0.1.1 / 2023-10-27

  • [CHANGE] Upgraded PyYAML module from 5.4.1 to 6.0.1 due to the following issue.
  • [ENHANCEMENT] Updated README.md.
  • [ENHANCEMENT] Added a new stage for vulnerability scanning of Docker images.