Skip to content

Commit

Permalink
Merge pull request #1909 from PFYasu/RDoc-2949
Browse files Browse the repository at this point in the history
RDoc-2948 & RDoc-2949 Cloud Cluster Health documentation
  • Loading branch information
ppekrol authored Sep 30, 2024
2 parents d0d4a23 + e2ccdbc commit fab3444
Show file tree
Hide file tree
Showing 250 changed files with 178 additions and 639 deletions.
6 changes: 6 additions & 0 deletions Documentation/4.2/Raven.Documentation.Pages/cloud/.docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,11 @@
"Name": "Maintenance & Troubleshooting",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
},
{
"Path": "cloud-features.markdown",
"Name": "Product Features",
"DiscussionId": "0533554b-605e-450d-92bf-a6752764498a",
"Mappings": []
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,21 @@ cloud you have no direct access to.
You can [view and restore](../cloud/cloud-backup-and-restore#restore-mandatory-backup-files) them using your portal's Backups tab and the
management Studio.

{NOTE: }
A backup created for data hosted by a server in Europe or the US
will be kept within the same [geographical region](https://cloud.ravendb.net/pricing),
i.e. backups made for a database hosted in Europe are kept in Europe
and backups made for a database hosted in the US are kept in the US.
{NOTE/}

{NOTE: Backup location - GDPR/DPA consideration}
Upon backup geographically closest AWS S3 bucket is used for backup storage e.g. :

- if your RavenDB Cloud cluster has been created in Europe, it backs up to AWS S3 buckets in Europe.

- if your RavenDB Cloud cluster has been created in the US, it backs up to AWS S3 buckets in the US.
{NOTE/}

---

####Custom-Backup Storage
Expand Down Expand Up @@ -157,7 +172,6 @@ Backup files that have already been created, are listed in the backups tab.
Its backups will be shown, listed by the databases they've been created for.
* Click "Generate Backup Link" for the database you want to restore.
The backup link window will open.

!["Backups List"](images\backup-and-restore-002-mandatory-backups-tab-list.png "Backups List")

---
Expand Down Expand Up @@ -206,4 +220,4 @@ Clicking the **Generate Backup Link** button will show you a simple procedure. F
[Backup Overview](../server/ongoing-tasks/backup-overview)

**Studio**
[Backup Task](../studio/database/tasks/ongoing-tasks/backup-task)
[Backup Task](../studio/database/tasks/backup-task)
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*RavenDB Cloud* provides *OLAP ETL* capabilities, allowing you to integrate your operational data with analytical data
warehouses.

Usage of this feature is described [here](../studio/database/tasks/ongoing-tasks/olap-etl-task).
Usage of this feature is described [here](https://ravendb.net/docs/article-page/latest/csharp/studio/database/tasks/ongoing-tasks/olap-etl-task).

{PANEL/}

Expand All @@ -16,7 +16,7 @@ Usage of this feature is described [here](../studio/database/tasks/ongoing-tasks
to seamlessly connect your RavenDB data with *Power BI* for advanced visualization and reporting, enabling real-time
insights and data-driven decision-making.

Usage of this feature is described [here](../integrations/postgresql-protocol/power-bi).
Usage of this feature is described [here](https://ravendb.net/docs/article-page/latest/csharp/integrations/postgresql-protocol/power-bi).

## Configuration

Expand Down Expand Up @@ -47,7 +47,7 @@ The *Queue ETL* feature enables you to export data from *RavenDB* to various que
This is particularly useful for scenarios where you need to process data asynchronously or distribute it
to other microservices and applications.

Usage of this feature is described [here](../server/ongoing-tasks/etl/queue-etl/overview).
Usage of this feature is described [here](https://ravendb.net/docs/article-page/latest/csharp/server/ongoing-tasks/etl/queue-etl/overview).

{PANEL/}

Expand All @@ -57,7 +57,7 @@ Usage of this feature is described [here](../server/ongoing-tasks/etl/queue-etl/
database from external systems or services. This feature is ideal for integrating with event-driven architectures
where data is processed and ingested in real time.

Usage of this feature is described [here](../server/ongoing-tasks/queue-sink/overview).
Usage of this feature is described [here](https://ravendb.net/docs/article-page/latest/csharp/server/ongoing-tasks/queue-sink/overview).

{INFO: Availability }
This feature is available only for *RavenDB* **6.0 and newer**.
Expand All @@ -72,7 +72,7 @@ Archived documents are compressed and can be handled differently by *RavenDB* fu
archived documents from indexes and Data Subscriptions can avoid sending archived docs to workers), helping to keep the
database smaller and quicker and its contents more relevant.

Usage of this feature is described [here](../server/extensions/archival).
Usage of this feature is described [here](https://ravendb.net/docs/article-page/latest/csharp/server/extensions/archival).

{INFO: Availability }
This feature is available only for *RavenDB* **6.0 and newer**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,80 @@ status.
| Low uptime - below 12 hours | Product's uptime has been below 12 hours for at least 24 hours. |
| Low uptime - below 48 hours | Product's uptime has been below 48 hours for at least 96 hours. |

{PANEL/}

{PANEL: Cluster Health}

**Cluster Health** helps keep your cluster healthy by providing suggestions and incidents history.
This dashboard has two separated sections:

- [Incidents History](cloud-maintenance-troubleshooting#incidents-history)
- [Suggestions](cloud-maintenance-troubleshooting#suggestions)

---

## Incidents History

The *RavenDB Cloud* monitoring system tracks incidents and cluster performance.
This section lets you analyse your cluster incidents for a selected *time period*, *cluster node*, *severity* and *category*.

!["Cluster Health: Incidents History section"](images\cluster-health-incidents-history.png "Cluster Health: Incidents History section")

#### Categories and their descriptions

Incidents are split into *six* categories. **Description** column contains additional information about the incidents.

| Category name | Description |
|---------------|----------------------------------------------------------------------------------------|
| Uptime | Product's uptime has been below a specified time. |
| Memory | Product is running low on available memory. |
| CPU | Product is running low on CPU credits or experiencing a high level of CPU utilization. |
| Disk | Product's available disk space is low. |
| IO | Product is experiencing high input/output operations. |
| Availability | Product is currently not responding to input or commands or has been restarted. |

---

## Suggestions

This section displays suggestions for a selected *cluster node* based on incident trends.

!["Cluster Health: Suggestions section"](images\cluster-health-suggestions.png "Cluster Health: Suggestions section")

Suggestions are generated based on a 60-day period divided in half.

**First period** (hereinafter referred to as **previous period**) lasts from `now - 60 days` to `now - 30 days`.
**Second period** (hereinafter referred to as **current period**) lasts from `now - 30 days` to `now`.

#### Suggestion types

**Cluster Health** is able to generate suggestions for *five* usage areas:

- High CPU usage
- High IO usage
- Low memory mode
- Low CPU credits
- Server restarted due to Out of Memory

#### Analyses

Suggestions are generated using three types of analyses for specific suggestion types:

| Analyse type | Applicable to | Description |
|--------------------------------------------------|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| Current period above previous period by percents | High CPU usage, High IO usage, Low memory mode, Low CPU credits | The duration of a specific event was longer in the current period than in the previous period. |
| Current period above previous period by numbers | Server restarted due to Out of Memory | The number of occurrences of a specific event was higher in the previous period than in the current period. |
| Current period above threshold by percents | High CPU usage, High IO usage, Low memory mode, Low CPU credits | The duration of a specific event in the current period was longer than the threshold (5%). |

Below examples of the suggestions with the analyses:

!["Cluster Health: An example of `Current period above previous period by percents` analyse"](images\cluster-health-suggestions-current-month-above-previous-month-by-percents.png "Cluster Health: An example of `Current period above previous period by percents` analyse")


!["Cluster Health: An example of `Current period above previous period by numbers` analyse"](images\cluster-health-suggestions-current-month-above-previous-month-by-numbers.png "Cluster Health: An example of `Current period above previous period by numbers` analyse")


!["Cluster Health: An example of `Current period above threshold by percents` analyse"](images\cluster-health-suggestions-current-month-above-threshold-by-percents.png "Cluster Health: An example of `Current period above threshold by percents` analyse")


{PANEL/}
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,19 @@ Configure the Client Certificate's **Database Permissions** to include the datab

---

In the Destination Server, create or select an empty database and open its **Settings --> Import Data** option.
In the Destination Server, create or select an empty database and open its **Tasks --> Import Data** option.

!["Import Data"](images\migration-006-import-data.png "import data")
!["Import Data"](images\migrating-data-from-ravendb-steps.png "import data")

---
1. Select the **Tasks** tab.
2. Select **Import Data**.
3. Select the **From RavenDB** tab.
4. Select the destination server.
5. **Make sure that you are not writing over data that you want to keep**. One option is [to start a new database with the studio](https://ravendb.net/docs/article-page/5.2/csharp/studio/database/create-new-database/general-flow). If you create a new one, choose the new database server in step 4 (above).
6. Enter the URL of the source server and choose which data to migrate.
7. Click **Migrate Database**

Enter the URL of the source server.
Choose which data to migrate, and click **Migrate Database**.

!["Import Options"](images\migration-007-options.png "Import Options")

{PANEL/}

Expand All @@ -77,20 +80,34 @@ Another option is to [export a database](../studio/database/tasks/export-databas
`.ravenDBDump` format, and upload it to another database using the
[import data from file](../studio/database/tasks/import-data/import-data-file) operation.
This option doesn't require passing certificates:
{NOTE: Encryption}
If you selected encryption during the export, you also need to select encryption during the import.
{NOTE/}

---

In the source server, select a database to export and go to **Settings --> Export Database**.
After choosing which data to export, click **Export Database**.
#### First export the data from source server

!["Export Data to File"](images\studio-view-export-database-tofile-steps.png "Export Data to File")

1. In the source server, select a database to export and go to **Tasks tab**.
2. Select **Export Database**.
3. Change the destination file name if you'd prefer (optional).
4. Select desired options.
Note that **Encrypt Exported File** is off by default.
5. After choosing which data to export, click **Export Database**.

---

In the destination server, go to **Settings --> Import Database**.
Click the **From file (.ravendbdump)** tab.
Select the file and click **Import Database**.
#### Next import the data to destination server from file

!["Import Data from File"](images\studio-view-import-fromfile-steps.png "Import Data from File")

1. In the destination server, go to **Tasks** tab.
2. Select **Import Data**.
3. **Make sure that you are not writing over data that you want to keep**.
One option is [to start a new database with the studio](https://ravendb.net/docs/article-page/5.2/csharp/studio/database/create-new-database/general-flow).
4. Select the `.ravendbdump` file that you previously exported from the source server.
5. Select desired options.
**If you encrypted while exporting** make sure to select **imported file is encrypted**.
6. Click **Import Database**.

{PANEL/}

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit fab3444

Please sign in to comment.