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

Scaling and resource monitoring #480

Merged
merged 6 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/architecture/self-hosted/download-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Download logs
id: download-logs
description: Download Prophecy support logs
sidebar_position: 5
sidebar_position: 6
tags:
- download
- support logs
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/self-hosted/generate-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Generate API key
id: generate-api-key
description: Generate your own custom API key per deployment
sidebar_position: 6
sidebar_position: 7
tags:
- Generate
- API
Expand Down
Binary file added docs/architecture/self-hosted/img/monitoring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 40 additions & 0 deletions docs/architecture/self-hosted/resource-monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Resource monitoring
id: resource-monitoring
description: Find an overview of resource monitoring, alert configuration, and scaling recommendations
sidebar_position: 5
tags:
- scaling
- resources
- monitoring
---

This page provides an overview of resource monitoring, alert configuration, and scaling recommendations for effectively managing Prophecy deployments.

## Monitoring

To have a better understanding of how Prophecy is using resources, you can find an overview in **Settings > Admin > Monitoring**.

![Monitoring settings](./img/monitoring.png)

## Alerts

To set up automated alerts about your resource usage, visit the page on [Alerts Configuration](docs/architecture/self-hosted/configurations/configure-alerts.md).

## Scaling

Scaling is taken care of by the **Autoscaler** component in our platform. Therefore, if something happens like the number of
users increases by 10 times, the Prophecy deployment can be scaled appropriately.

The following are estimated recommended cluster sizes depending on the number of concurrent users:

| Number of users | 25 | 50 | 100 |
| ------------------------- | -------- | -------- | --------- |
| CPUs | 56 vCPUs | 96 vCPUs | 180 vCPUs |
| Memory | 128 GB | 256 GB | 440 GB |
| Disk space (with backups) | 360 GB | 720 GB | 1440 GB |

:::info
The recommended resource may vary based on the intensity of the usage of each developer. The numbers
presented above are based on the average recorded usage of Prophecy customers.
:::
4 changes: 4 additions & 0 deletions docs/architecture/self-hosted/upgrade-backup-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ Below is a list of supported variables that you can change.
| `backupRetentionCount` | Number of last `N` backups to retain. | `30` |
| `enableRegularBackups` | State of automated backup creation. | `false` |

### View past backups

You can view a history of backups in **Settings > Admin > Backup**.

### Additional backup APIs

Here is a list of additional APIs for backups. One sample call may look like:
Expand Down
Loading