Metrics Builder acts as a middleware between the consumers (i.e. analytic clients or tools) and the producers (i.e. the databases). Its provides APIs for the web applications and the Grafana Datasource Plugin, and accelerates the data query performance.
Metrics Builder API is a OpenAPI-enabled Flask server that is generated by the OpenAPI Generator project. YAML file ./openapi/openapi.yaml
is the OpenAPI specification of this API service. Users can modify the spec according to their needs. Once openapi.yaml
is updated, users can run ./openapi/gen.sh
to update the code generated from openapi.yaml
.
Documentation for API Endpoints
Python 3.5.2+
To run the server, please execute the following from the password directory:
pip3 install -r requirements.txt
python3 mbapi.py
and open your browser to here:
http://localhost:8080/ui/
Your OpenAPI definition lives here:
http://localhost:8080/openapi.json