Documentation - Service diagrams - #17
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
POST /api/v1/metricsGET /api/v1/sensors/:sensorId/statusThe 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.