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

Added snapshotless observing squad in the integrators section #749

Merged
merged 5 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from 4 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
1 change: 1 addition & 0 deletions docs/integrators/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ uses its own infrastructure, please choose a direction from the following table
| [EGLD integration guide](/integrators/egld-integration-guide) | How to integrate MultiversX's native token EGLD. |
| [ESDT tokens integration guide](/integrators/esdt-tokens-integration-guide) | How to integrate MultiversX's ESDT tokens. |
| [Observing squad](/integrators/observing-squad) | How to run an infrastructure with a general view over all the shards. |
| [Snapshotless Observing squad](/integrators/snapshotless-observing-squad) | How to set up a light Observing squad with access to real time state only. |
| [Deep-history squad](/integrators/deep-history-squad) | How to set up an Observing squad able to resolve historical state queries. |
| [Accounts management](/integrators/accounts-management) | How to create and manage EGLD accounts. |
| [Creating transactions](/integrators/creating-transactions) | How to create and sign transactions. |
Expand Down
68 changes: 68 additions & 0 deletions docs/integrators/snapshotless-observing-squad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
id: snapshotless-observing-squad
title: Snapshotless Observing Squad
---

[comment]: # (mx-abstract)

This page describes the Snapshotless Observing Squad, a type of Observing Squad optimized for real-time requests such as accounts data fetching and vm-query operations.
More details related to exposed endpoints are available [here](/sdk-and-tools/proxy/#proxy-snapshotless-endpoints).

ovidiuolteanu marked this conversation as resolved.
Show resolved Hide resolved
[comment]: # (mx-context-auto)

## Overview

Whenever a node is executing the trie snapshotting process, the accounts data fetching & vm-query operations can be greatly affected.
This is caused by the fact that the snapshotting operation has a high CPU and disk I/O utilization.
The nodes started with the flag `--operation-mode snapshotless-observer` will not create trie snapshots on every epoch and will also prune the trie storage in order to save space.

## Setup

### Creating a Snapshotless Observing Squad from scratch

If you choose to install a snapshotless observing squad from scratch, you should follow the instruction from the [observing squad section](/integrators/observing-squad) and remember to add in the `variables.cfg` file the operation mode in the node's extra flags definition:
```
NODE_EXTRA_FLAGS="-log-save -operation-mode snapshotless-observer"
```

After that, you can resume the normal Observer Squad installation steps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ObservING Squad?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed


### Converting a normal Observing Squad to a Snapshotless Observing Squad

If you already have an Observing Squad, and you want to transform it into a Snapshotless Observing Squad, the easiest way is to manually edit the service file `/etc/systemd/system/elrond-node-x.service` (with `sudo`) and append the `-operation-mode snapshotless-observer` flag at the end of the `ExecStart=` line.
In the end, the file should look like:
```
[Unit]
Description=MultiversX Node-0
After=network-online.target

[Service]
User=jls
WorkingDirectory=/home/ubuntu/elrond-nodes/node-0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps, at some point, the installation scripts should create a symlink (mvx-nodes)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will fix that with @valentin-lup in the future

ExecStart=/home/ubuntu/elrond-nodes/node-0/node -use-log-view -log-logger-name -log-correlation -log-level *:DEBUG -rest-api-interface :8080 -log-save -profile-mode -operation-mode snapshotless-observer
StandardOutput=journal
StandardError=journal
Restart=always
RestartSec=3
LimitNOFILE=4096

[Install]
WantedBy=multi-user.target
```

Save the file, and force a reload units with the command
raduchis marked this conversation as resolved.
Show resolved Hide resolved
```bash
sudo systemctl daemon-reload
```

After units reload, you can restart the nodes.

:::caution
Even if the nodes are synced, after changing the operation mode, they will start to re-sync their state in
"snapshotless" format.
:::

ovidiuolteanu marked this conversation as resolved.
Show resolved Hide resolved
[comment]: # (mx-context-auto)
### One click deploy in AWS
AWS instances for Snapshotless Observer Squads can be easily deployed via our Amazon Machine Image available in the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-pbwpmtdtwmkgs).

1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,7 @@ const sidebars = {
items: [
"integrators/observing-squad",
"integrators/deep-history-squad",
"integrators/snapshotless-observing-squad",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put the snapshotless-observing-squad page above the deep-history-squad.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed. More use-cases, more integrators that require snapshotless squads - as opposed to deep-history squads (more exotic, less used).

],
},
{
Expand Down
Loading