Skip to content

Add usage metrics to monitoring & alerting #12

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Add usage metrics to monitoring & alerting #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added images/usage-metrics.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions usage/tools/monitoring-and-alerting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: Overview of monitoring and alerting functionality for PowerSync ins

You can monitor activity and alert on issues and usage for your PowerSync instance(s):

* **Monitor Usage**: View time-series and aggregated usage data with [Usage Metrics](#usage-metrics)
* **Monitor Service and Replication Activity**: Track your PowerSync service and replication logs with [Instance Logs](#instance-logs)
* **Configure Alerts**: Set up alerts for connection issues or usage activity \*
* Includes [Issue Alerts](#issue-alerts) and/or [Metric Alerts](#metric-alerts)
Expand All @@ -20,6 +21,7 @@ Monitoring and alerting functionality varies by [PowerSync Cloud plan](https://w

| Feature | Free | Pro | Team & Enterprise |
|-------------------------|----------------------------------------|----------------------------------------|-----------------------------------------|
| **Usage Metrics** | Available | Available | Available |
| **Instance Logs** | Available | Available | Available |
| Log retention period | 24 hours | 7 days | 30 days |
| **Issue Alerts** | Fatal alerts (Coming soon) | Fatal alerts (Coming soon) | Fully configurable |
Expand All @@ -37,6 +39,28 @@ We plan to publish alerting APIs for Open Edition users, and an alerting service
Until this is available, please chat to us on our [Discord](https://discord.gg/powersync) to discuss your use case or any questions.
</info>

## Usage Metrics

View time-series and aggregated usage data for your PowerSync instance(s), including storage size, concurrent connections, and synced data and operations. This data lets you monitor activity, spot patterns or spikes, and easily budget while tracking your position within our [Cloud pricing plans](https://www.powersync.com/pricing).

### View Usage Metrics

Access usage metrics in the [Dashboard](/usage/tools/powersync-dashboard), in the **Metrics** workspace:

<Frame>
<img src="/images/usage-metrics.png"/>
</Frame>

You have following options:
* **Filter options**: data by time range.
* **Granularity**: See data in a daily or hourly granularity.
* **Aggregates**: View and copy aggregates for each usage metric.
* **CSV**: Download data as CSV for custom calculations.

<info>
This usage data is also available programatically via APIs. Chat to us on our [Discord](https://discord.gg/powersync) if you require details.
</info>

## Instance Logs

You can review logs for your PowerSync instance(s) to troubleshoot replication or sync issues. Logs capture activity from the PowerSync Service and Replicator processes.
Expand Down