Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Add Telemetry dashboard #19

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

stevensJourney
Copy link
Collaborator

@stevensJourney stevensJourney commented Jul 17, 2024

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:3121 after following the instructions in the NodeJS readme file. The Telemetry dashboard contains various telemetry in panels.

image

Caveats

The opentelemetry, prometheus and grafana config 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.

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.

1 participant