Skip to content

Update issue alerts availability #40

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
Nov 26, 2024
Merged

Update issue alerts availability #40

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
44 changes: 21 additions & 23 deletions usage/tools/monitoring-and-alerting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ Monitoring and alerting functionality varies by [PowerSync Cloud plan](https://w
| **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 |
| **Metric Alerts** | Not available | Not available | Fully configurable |
| **Alert Notifications** | - Email (Coming soon) | - Webhooks<br/>- Email (Coming soon) | - Webhooks<br/>- Email (Coming soon) |
| **Issue Alerts** | Available | Available | Available |
| **Metric Alerts** | Not available | Not available | Available |
| **Alert Notifications** | - Email (Coming soon) | - Webhooks <br/>- Email (Coming soon) | - Webhooks <br/>- Email (Coming soon) |


<info>
<Info>
**Self-hosting PowerSync**

Similar monitoring and alerting functionality is planned for PowerSync Open Edition users and Enterprise Self-Hosted customers.

We plan to publish alerting APIs for Open Edition users, and an alerting service with customization options and webhook integration for Enterprise Self-Hosted customers.
For Open Edition users, alerting APIs are currently available in an early access release. For Enterprise Self-Hosted customers we are planning a full alerting service that includes customizable alerts and webhook integrations.

Until this is available, please chat to us on our [Discord](https://discord.gg/powersync) to discuss your use case or any questions.
</info>
</Info>

## Usage Metrics

Expand All @@ -57,9 +57,9 @@ You have following options:
* **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>
<Info>
This usage data is also available programatically via APIs in an early access release. Chat to us on our [Discord](https://discord.gg/powersync) if you require details.
</Info>

## Instance Logs

Expand All @@ -68,15 +68,15 @@ You can review logs for your PowerSync instance(s) to troubleshoot replication o
* **Service logs**: Reflect sync activity from the PowerSync Service to clients.
* **Replicator logs**: Reflect replication activity from your source database to the PowerSync Service.

<info>
<Note>
**Availability**

The log retention period varies by plan:

* **Free** plan: Logs from the last 24 hours
* **Pro** plan: Logs from the last 7 days
* **Team & Enterprise** plans: Logs from the last 30 days
</info>
</Note>

### View Instance Logs

Expand All @@ -88,7 +88,7 @@ Access instance logs through the [Dashboard](/usage/tools/powersync-dashboard),

You can manage logs with the following options:

* **Filter Options**: Filter logs by level (`Info`, `Error`, `Warning`, `Debug`) and by date range.
* **Filter Options**: Filter logs by level (`Note`, `Error`, `Warning`, `Debug`) and by date range.
* **Sorting**: Sort logs by newest or oldest first.
* **Service Logs Metadata**: Include metadata like `user_id` and `user_agent` in the logs if available.
* **View Mode**: Tail logs in real-time or view them statically.
Expand All @@ -98,12 +98,11 @@ You can manage logs with the following options:

Issue alerts capture potential problems with your instance, such as connection or sync issues.

<info>
<Note>
**Availability**

* Coming soon: **Free** and **Pro** plan customers will be able to opt in to receive fatal issue alerts.
* **Team** and **Enterprise** customers can customize the issue type and severity level for which an alert should trigger.
</info>
* Issue alerts are available on all Cloud plans.
</Note>

### Configure Issue Alerts

Expand Down Expand Up @@ -140,11 +139,11 @@ See [Webhooks](#webhooks) below to notify external systems when an alert is trig

Metric alerts trigger when specific usage metrics exceed a defined threshold. This helps with troubleshooting usage spikes, or unexpected usage activity.

<info>
<Note>
**Availability**

Metrics alerts are available on **Team** and **Enterprise** plans.
</info>
</Note>

### Configure Metric Alerts

Expand Down Expand Up @@ -183,13 +182,12 @@ See [Webhooks](#webhooks) below to notify external systems when an alert is trig

Webhooks enable you to notify external systems when specific events occur in PowerSync, such as issue or metric alerts.

<info>
<Note>
**Availability**

* Webhooks are currently available on **Team** and **Enterprise** plans.
* Coming soon: **Pro** plan customers will be able to set up webhooks for Issue alerts.
* Email notifications will be available in a future release (also for **Free** plan users).
</info>
* Webhooks are currently available on **Pro**, **Team** and **Enterprise** plans.
* Email notifications will be available in a future release (these will also be available to **Free** plan users).
</Note>

### Set Up Webhooks

Expand Down