Skip to content

Commit ffb5cf3

Browse files
nymkappagitbook-bot
nymkappa
authored and
gitbook-bot
committed
GitBook: [master] 72 pages modified
1 parent 484a462 commit ffb5cf3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+8695
-36
lines changed

‎SUMMARY.md

+37
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,40 @@
6060
* [Swift SDK](icon-sdks/swift-sdk/README.md)
6161
* [Swift API Reference](icon-sdks/swift-sdk/swift-api-reference.md)
6262

63+
## ICONex Connect
64+
65+
* [Chrome Extension](iconex-connect/chrome-extension.md)
66+
* [iOS](iconex-connect/ios.md)
67+
* [Android](iconex-connect/android.md)
68+
69+
## ICON Node
70+
71+
* [Quickstart](icon-node/quickstart.md)
72+
* [P-Rep Tools](icon-node/p-rep-tools.md)
73+
* [Maintenance](icon-node/maintenance.md)
74+
* [Node operation and configuration](icon-node/node-operation-and-configuration.md)
75+
* [Understanding log files](icon-node/understanding-log-files.md)
76+
* [How to collect centralized logging](icon-node/how-to-collect-centralized-logging.md)
77+
* [Backup and restore DB guide](icon-node/backup-and-restore-db-guide.md)
78+
79+
## Oracles
80+
81+
* [Band Protocol](oracles/band-protocol.md)
82+
83+
## References
84+
85+
* [How-to](references/how-to/README.md)
86+
* [Set up a Keystore file on a P-Rep Node](references/how-to/set-up-a-keystore-file-on-a-p-rep-node.md)
87+
* [Create an account](references/how-to/create-an-account.md)
88+
* [Change network in ICONex](references/how-to/change-network-in-iconex.md)
89+
* [Deploy a SCORE](references/how-to/deploy-a-score.md)
90+
* [Estimate required step](references/how-to/estimate-required-step.md)
91+
* [Write SCORE unit test](references/how-to/write-score-unit-test.md)
92+
* [Write SCORE integration test](references/how-to/write-score-integration-test.md)
93+
* [Generate a transaction signature](references/how-to/generate-a-transaction-signature.md)
94+
* [Create own blockchain network from AWS marketplace](references/how-to/create-own-blockchain-network-from-aws-marketplace.md)
95+
* [Reference Manuals](references/reference-manuals/README.md)
96+
* [ICON JSON-RPC API v3 Specification](references/reference-manuals/icon-json-rpc-api-v3-specification.md)
97+
* [JSON Standard for P-Rep Detailed Information](references/reference-manuals/json-standard-for-p-rep-detailed-information.md)
98+
* [ICON Governance SCORE APIs](references/reference-manuals/icon-governance-score-apis.md)
99+

‎icon-node/backup-and-restore-db-guide.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Backup and restore DB guide
2+

‎icon-node/how-to-collect-centralized-logging.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# How to collect centralized logging
2+
3+
This document is a guideline about How to collect centralized logging on the MainNet.
4+
5+
### Intended Audience
6+
7+
We recommend all P-Rep candidates to go through this guideline.
8+
9+
### Purpose
10+
11+
This section describes how to use `fluentd` to collect/ manage/ and analyze logs generated when a node is running.
12+
13+
P-Rep node will create a log file as noted below. The log file can be used to identify service operation information and cause of failure.
14+
15+
### Pre-requisites
16+
17+
We assume that you have previous knowledge and experience in:
18+
19+
* IT infrastructure management
20+
* Linux or UNIX system administration
21+
* Linux server and docker service troubleshooting
22+
* Docker container
23+
24+
**Description of log files in prep-node**
25+
26+
| service name | log file name |
27+
| :--- | :--- |
28+
| docker container booting | booting.log |
29+
| iconrpcserver | iconrpcserver.log |
30+
| iconservice | iconservice.log |
31+
| loopchain | loopchain.channel-txcreator-icon\_dex\_broadcast.icon\_dex.log |
32+
| | loopchain.channel-txcreator.icon\_dex.log |
33+
| | loopchain.channel-txreceiver.icon\_dex.log |
34+
| | loopchain.channel.icon\_dex.log |
35+
36+
The logs can be managed on the local disk. However, in order to manage the old log files and the large log files, the log should be kept in a separate space. In addition, multiple nodes may be operated depending on network modeling. It is recommended to collect and analyze logs from the central server rather than accessing the server each time to check the logs of multiple nodes.
37+
38+
**Logging architecture**
39+
40+
The below diagram shows the architecture of log collection/analysis method using Fluent, Elasticsearch, and Kibana.
41+

‎icon-node/maintenance.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Maintenance
2+

‎icon-node/node-operation-and-configuration.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Node operation and configuration
2+
3+
### **Start Node**
4+
5+
**Run docker-compose up.**
6+
7+
```text
8+
$ docker-compose up -d
9+
```
10+
11+
The `docker ps` command shows the list of running docker containers.
12+
13+
```text
14+
$ docker ps
15+
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
16+
0de99e33cdc9 iconloop/prep-node:1910261021xc97f33 "/src/entrypoint.sh" 2 minutes ago Up 2 minutes(healthy) 0.0.0.0:7100->7100/tcp, 0.0.0.0:9000->9000/tcp prep_prep_1
17+
```
18+
19+
Corresponding columns,
20+
21+
| Column | Description |
22+
| :--- | :--- |
23+
| CONTAINER ID | Container ID |
24+
| IMAGE | P-Rep Node's image name |
25+
| COMMAND | The script will be executed whenever a P-Rep Node container is run |
26+
| STATUS | Healthcheck status. One of "starting" , "healthy", "unhealthy" or "none" |
27+
| PORTS | Exposed ports on the running container |
28+
| NAMES | Container name |
29+
30+
You can read the container booting log from the log folder.
31+
32+
```text
33+
$ tail -f data/PREP-MainNet/log/booting_20190419.log
34+
[2019-10-28 10:43:05.204] Your IP: xx.xx.xx.xx
35+
[2019-10-28 10:43:05.209] RPC_PORT: 9000 / RPC_WORKER: 3
36+
[2019-10-28 10:43:05.214] DEFAULT_PATH=/data/mainnet in Docker Container
37+
[2019-10-28 10:43:05.219] DEFAULT_LOG_PATH=/data/mainnet/log
38+
[2019-10-28 10:43:05.224] DEFAULT_STORAGE_PATH=/data/mainnet/.storage
39+
[2019-10-28 10:43:05.229] scoreRootPath=/data/mainnet/.score_data/score
40+
[2019-10-28 10:43:05.234] stateDbRootPath=/data/mainnet/.score_data/db
41+
[2019-10-28 10:43:05.239] Time synchronization with NTP / NTP SERVER: time.google.com
42+
[2019-10-28 10:43:12.022] P-REP package version info - _1910261021xc97f33
43+
[2019-10-28 10:43:12.853] iconcommons 1.1.2
44+
iconrpcserver 1.4.5
45+
iconsdk 1.2.0
46+
iconservice 1.5.15
47+
loopchain 2.4.16
48+
```
49+
50+
### **Entrypoint.sh Diagram**
51+

0 commit comments

Comments
 (0)