Skip to content

Documentation - Service diagrams - #17

Merged
Arthur-Bottemanne merged 2 commits into
mainfrom
develop
Mar 27, 2026
Merged

Documentation - Service diagrams#17
Arthur-Bottemanne merged 2 commits into
mainfrom
develop

Conversation

@dieperid

Copy link
Copy Markdown
Member

Summary

This PR adds project documentation diagrams to make the metrics service easier to understand from both a system and runtime perspective.

What Changed

Details

The architecture/data-flow diagram was updated to preserve the upstream ingestion context with the temperature sensor, MQTT broker, ingestion worker, and device registry service, while also showing how requests are handled inside this repository through the Gin router, handlers, metric registry/validator, VictoriaMetrics service, and VictoriaMetrics itself.

The sequence diagrams document the main application flows:

  • metric ingestion via POST /api/v1/metrics
  • sensor status retrieval via GET /api/v1/sensors/:sensorId/status

The deployment diagram was added because the service behavior depends on the Docker Compose boundary between the Go API container and the VictoriaMetrics container, including environment-based configuration and persistent storage.

Notes

This PR is documentation-only and does not change application behavior.

@dieperid dieperid self-assigned this Mar 27, 2026
@Arthur-Bottemanne
Arthur-Bottemanne merged commit f0c15ad into main Mar 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants