Skip to content

Commit

Permalink
fix: obsolete info about networks and telemetry
Browse files Browse the repository at this point in the history
  • Loading branch information
shamilsan committed Nov 28, 2023
1 parent 0909e8b commit 94e6531
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 29 deletions.
22 changes: 11 additions & 11 deletions docs/node/multi-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ Note: this will require two terminal sessions (one for each node).
--chain=local \
--alice \
--node-key 0000000000000000000000000000000000000000000000000000000000000001 \
--telemetry-url 'ws://telemetry-backend-shard.gear-tech.io:32001/submit 0'
--telemetry-url "wss://telemetry.rs/submit 0"
```

The Alice node will be run in idle mode at block #0 waiting for the second validator node.

```
Gear Node
✌️ version 0.1.0-6dc8d24edd9
❤️ by Gear Technologies, 2021-2022
📋 Chain specification: Gear Local Testnet
✌️ version 1.0.2-d02d306f97c
❤️ by Gear Technologies, 2021-2023
📋 Chain specification: Vara Local Testnet
🏷 Node name: Alice
👤 Role: AUTHORITY
💾 Database: RocksDb at /tmp/alice/chains/gear_local_testnet/db/full
⛓ Native runtime: gear-610 (gear-1.tx1.au1)
⛓ Native runtime: vara-1020 (vara-1.tx1.au1)
👶 Creating empty BABE epoch changes on what appears to be first startup.
Using default protocol ID "sup" because none is configured in the chain specs
🏷 Local node identity is: 12D3KooWEyoppNCUx8Yx66oV9fJnriXwCcXwDDUA2kj6vnc6iDEp
Expand All @@ -53,7 +53,7 @@ Note: this will require two terminal sessions (one for each node).
💤 Idle (0 peers), best: #0 (0x22c7…6847), finalized #0 (0x22c7…6847), ⬇ 0 ⬆ 0
```

Also, you can find the `Alice` node name on the telemetry site (https://telemetry.gear-tech.io) under the **Gear Local Testnet** tab.
Also, you can find the `Alice` node name on the telemetry site (https://telemetry.rs) under the **Gear Local Testnet** tab.

2. In another terminal, use the following command to start Bob's node on a different TCP port (`30334`) and with a chain database location of `/tmp/bob`. The `--bootnodes` option will connect this node to the Alice's one on TCP port `30333`:

Expand All @@ -65,20 +65,20 @@ Note: this will require two terminal sessions (one for each node).
--bob \
--port 30334 \
--ws-port 9945 \
--telemetry-url 'ws://telemetry-backend-shard.gear-tech.io:32001/submit 0'
--telemetry-url "wss://telemetry.rs/submit 0"
```

After running the second validator the network starts to produce new blocks.

```
Gear Node
✌️ version 0.1.0-6dc8d24edd9
❤️ by Gear Technologies, 2021-2022
📋 Chain specification: Gear Local Testnet
✌️ version 1.0.2-d02d306f97c
❤️ by Gear Technologies, 2021-2023
📋 Chain specification: Vara Local Testnet
🏷 Node name: Bob
👤 Role: AUTHORITY
💾 Database: RocksDb at /tmp/bob/chains/gear_local_testnet/db/full
⛓ Native runtime: gear-610 (gear-1.tx1.au1)
⛓ Native runtime: vara-1020 (vara-1.tx1.au1)
🔨 Initializing Genesis block/state (state: 0xf470…d2dc, header-hash: 0x22c7…6847)
👴 Loading GRANDPA authority set from genesis on what appears to be first startup.
👶 Creating empty BABE epoch changes on what appears to be first startup.
Expand Down
2 changes: 1 addition & 1 deletion docs/node/node-as-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ After=network.target
Type=simple
User=root
WorkingDirectory=/root/
ExecStart=/usr/bin/gear --name "NODE_NAME" --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0"
ExecStart=/usr/bin/gear --name "NODE_NAME" --telemetry-url "wss://telemetry.rs/submit 0"
Restart=always
RestartSec=3
LimitNOFILE=10000
Expand Down
2 changes: 1 addition & 1 deletion docs/node/node-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ $$

## Is the node visible in telemetry during syncing?

Yes, it is visible on the telemetry portal - https://telemetry.gear-tech.io. It will be gray until the block height becomes up to date.
Yes, it is visible on the telemetry portal - https://telemetry.rs. It will be gray until the block height becomes up to date.

## Should I associate my wallet with the node?

Expand Down
12 changes: 8 additions & 4 deletions docs/node/setting-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,17 +217,21 @@ To run Gear node in dev mode use the following command:
gear [subcommand] [options]
```

- `--chain=staging`
- `--chain=testnet`

Connect the node to Gear testnet (default option).
Connect the node to the test network (default option).

- `--chain=vara`

Connect the node to the Vara network.

- `--dev`

Run standalone node of Gear network.
Run a local node in development mode for testing purposes. This node will not be connected to any external network and will store the state in temporary storage.

- `purge-chain`

Remove storage of the selected chain type. Needs to specify the chain connection type `--chain=staging` or `--dev`
Remove storage of the selected chain type. Needs to specify the chain connection type `--chain=testnet`, `--chain=vara`, or `--dev`.

- `help`, `--help`

Expand Down
14 changes: 11 additions & 3 deletions docs/node/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To start sending telemetry messages to the arbitrary telemetry server instance,
If you want to participate and share your telemetry, run your node with the flag (we assume the executable is in `/usr/bin` directory):

```sh
gear --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0"
gear --telemetry-url "wss://telemetry.rs/submit 0"
```

Also, you can provide your node name using the `--name` flag:
Expand All @@ -26,7 +26,15 @@ gear --name "NODE NAME"
For example, to start a node with telemetry, run the command:

```sh
gear --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0" --name "My_Gear_node_name"
gear --telemetry-url "wss://telemetry.rs/submit 0" --name "My_Gear_node_name"
```

To check telemetry for currently running nodes, visit the web address: [https://telemetry.gear-tech.io](https://telemetry.gear-tech.io).
You can send more information (e.g., the validator address) by increasing the verbosity level:

```sh
gear --telemetry-url "wss://telemetry.rs/submit 1" --name "My_validator_name"
```

To check telemetry for currently running nodes, visit the web address: [https://telemetry.rs](https://telemetry.rs).

You can find some additional information about monitoring in the [Substrate docs](https://docs.substrate.io/maintain/monitor/).
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ sidebar_position: 5
--chain=local \
--alice \
--node-key 0000000000000000000000000000000000000000000000000000000000000001 \
--telemetry-url 'ws://telemetry-backend-shard.gear-tech.io:32001/submit 0'
--telemetry-url "wss://telemetry.rs/submit 0"
```

Alice 节点将在 块#0 以空闲模式运行,等待第二个验证节点。
Expand Down Expand Up @@ -54,7 +54,7 @@ Alice 节点将在 块#0 以空闲模式运行,等待第二个验证节点。
💤 Idle (0 peers), best: #0 (0x22c7…6847), finalized #0 (0x22c7…6847), ⬇ 0 ⬆ 0
```

另外,你可以在监测网站(https://telemetry.gear-tech.io)的 **Gear Local Testnet** 标签下找到 `Alice` 节点名称。
另外,你可以在监测网站(https://telemetry.rs)的 **Gear Local Testnet** 标签下找到 `Alice` 节点名称。

2. 在另一个终端,使用下面的命令,在不同的 TCP 端口(30334)上启动 Bob 的节点,链数据库位置在 `/tmp/bob``--bootnodes` 选项将使 Bob 节点与 Alice 节点在 TCP `30333` 端口连接。

Expand All @@ -66,7 +66,7 @@ Alice 节点将在 块#0 以空闲模式运行,等待第二个验证节点。
--bob \
--port 30334 \
--ws-port 9945 \
--telemetry-url 'ws://telemetry-backend-shard.gear-tech.io:32001/submit 0'
--telemetry-url "wss://telemetry.rs/submit 0"
```

运行第二个验证者节点后,网络开始产生新的区块。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ After=network.target
Type=simple
User=root
WorkingDirectory=/root/
ExecStart=/usr/bin/gear --name "NODE_NAME" --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0"
ExecStart=/usr/bin/gear --name "NODE_NAME" --telemetry-url "wss://telemetry.rs/submit 0"
Restart=always
RestartSec=3
LimitNOFILE=10000
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ syncing_time = (3313788 - 3223552) / 143.1 = 630 secs (10.5 mins)
```

### 节点同步时,是否可以在节点监控器中观察到该节点?
是的,你可以在节点监控器中看到该节点 —— https://telemetry.gear-tech.io。在区块高度完成更新前,该节点呈灰色。
是的,你可以在节点监控器中看到该节点 —— https://telemetry.rs。在区块高度完成更新前,该节点呈灰色。

### 在启动节点服务时,遇到了该问题 "error: Found argument '\' which wasn't expected, or isn't valid in this context" 请问如何解决?
`gear-node.service`配置文件似乎配置不当。请参考 - https://wiki.gear-tech.io/zh-cn/node/node-as-service/,将节点正确配置为一个服务。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ cd target/release
gear [flags] [options]
```

`--chain=staging`
`--chain=testnet`

链接到 Gear 测试网。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebar_position: 3
如果你愿意参与并分享你的监测数据,那么请使用一下选项来运行你的节点:

```sh
gear --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0"
gear --telemetry-url "wss://telemetry.rs/submit 0"
```

同时使用以下选项来提供你的节点名称:
Expand All @@ -26,7 +26,7 @@ gear --name "NODE NAME"
如何启动节点监测?`cd` 到你的节点二进制文件所在的目录,然后运行一下命令:

```sh
./gear --telemetry-url "ws://telemetry-backend-shard.gear-tech.io:32001/submit 0" --name "My_Gear_node_name"
./gear --telemetry-url "wss://telemetry.rs/submit 0" --name "My_Gear_node_name"
```

要检查当前运行节点的监测信息,请访问 [https://telemetry.gear-tech.io](https://telemetry.gear-tech.io)
要检查当前运行节点的监测信息,请访问 [https://telemetry.rs](https://telemetry.rs)

0 comments on commit 94e6531

Please sign in to comment.