This API exposes a Metrics endpoint to allow a prometheus instance to retrieve data.
- Works on Azure B1 Standard Virtual Machine
- You will need a working dotnet installation
- Build the docker file in PitWallDataGatheringApi folder to create the docker image.
docker build -f src/PitWallDataGatheringApi/PitWallDataGatheringApi/Dockerfile -t pitwalldatagatheringapi src/PitWallDataGatheringApi- Go the container folder
- Configure then simerkey
- Send the simerkey to the people you wish to have the data sent from
- Run the following command :
docker compose up -d- Create the container with docker compose with compose file in Container folder
At this point should have a running container with
- a Grafana instance
- a Prometheus instance
- a Pitwall API instance
The API is self documented by SWAGGER on one hand, and a documentation endpoint on the other hand.
| Endpoint name | Description |
|---|---|
| /api/v1/ApiHealthCheck | Used by the caller to check whether the API is here. |
| /api/v1/SeriesDocumentation | The description of each series being exposed to Prometheus |
| /api/v1/Telemetry | The endpoint to post telemetry to. |
The contract documentation is generated by swagger itself.
At minimum there are two mandatories fields in Telemetry model :
- Simerkey : The key to be able to post metrics to the API.
- Pilot Name : The pilot name is used to break series by pilot.
Forget one of these, and you'll be toss out immediately.
Althought the API has a simerkey to avoid being data poisoning, it do not have a embed DDOS security.
The system has been made very light to run almost anywhere without having coupling to an authentication system for now.
It should not be left active all the time because no advanced pentesting has been made.
Prometheus instance is not user password secured for reading data. That is a prometheus limitation. Therefore, you have to secure its access using port mapping and network filter.
I currently have not metrics about the growth of the disk space.
It works on a Standard B1 on Azure.