[Feature] Add Telemetry dashboard #19
Draft
Conversation
This file contains 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
|
Oh yeah! |
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.
Overview
The enterprise edition of the PowerSync self hosting Docker image supports custom telemetry integrations via configurable additional OTLP endpoints.
A telemetry integration has been added to the NodeJS demo.
This adds a OTLP collector which exports metrics to Prometheus. Prometheus is used as a data source in Grafana to visualize telemetry.
The Grafana dashboard should be accessible at
http://localhost:3121after following the instructions in the NodeJS readme file. TheTelemetrydashboard contains various telemetry in panels.Caveats
The
opentelemetry,prometheusandgrafanaconfig files reference each other's service config and ports quite often. This makes it tricky to configure with one source of trueth environment variable file.Todos
The metrics panels in the dashboard currently use very simple queries which only show the instantaneous values of meters and counters. Better queries with aggregations and other improved logic should still be implemented.