Skip to content

Commit 115985a

Browse files
author
Dylan Galea
committed
Added version 1.1.0
1 parent 8fe7bae commit 115985a

147 files changed

Lines changed: 1679 additions & 4007 deletions

File tree

Some content is hidden

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

.dockerignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
api
2-
alerter/config
3-
alerter/logs
1+
config
2+
logs

.gitignore

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11
.idea/
22
__pycache__/
3-
api/node_modules/
43

5-
alerter/logs/*.log*
6-
alerter/logs/*/*.log*
7-
!alerter/logs/alerts/.gitkeep
8-
!alerter/logs/general/.gitkeep
4+
logs/*.log*
5+
logs/*/*.log*
6+
!logs/alerts/.gitkeep
7+
!logs/general/.gitkeep
98

10-
alerter/config/user_config_main.ini
11-
alerter/config/user_config_nodes.ini
12-
alerter/config/user_config_repos.ini
13-
api/config/user_config_main.ini
14-
api/config/user_config_nodes.ini
9+
config/user_config_main.ini
10+
config/user_config_nodes.ini
11+
config/user_config_repos.ini
1512

1613
.coverage

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
5050
[homepage]: https://www.contributor-covenant.org
5151

5252
---
53-
[Back to contributing guidelines page](./CONTRIBUTING.md)
53+
[Back to contributing guidelines page](CONTRIBUTING.md)

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing guidelines
22

3-
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
3+
We welcome any kind of contribution to our software, from simple comment or question to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/). Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
44

55
A contribution can be one of the following cases:
66

@@ -43,4 +43,4 @@ In case you feel like you've made a valuable contribution, but you don't know ho
4343
Contribution guidelines adapted from [python-template](https://github.com/NLeSC/python-template).
4444

4545
---
46-
[Back to front page](./README.md)
46+
[Back to front page](README.md)

Pipfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ twilio = "*"
1313
python-telegram-bot = "*"
1414
python-dateutil = "*"
1515
redis = "*"
16+
pymongo = "*"

Pipfile.lock

Lines changed: 106 additions & 48 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PANIC for Polkadot
22

3-
<img src="./alerter/doc/IMG_PANIC.png" alt="design" width="600"/>
3+
<img src="doc/IMG_PANIC.png" alt="design" width="600"/>
44

55
PANIC for [Polkadot](https://polkadot.network/) is a lightweight yet powerful open source monitoring and alerting solution for Polkadot nodes by [Simply VC](https://simply-vc.com.mt/). It is compatible with any [Substrate](https://www.parity.io/substrate/) based chain provided that it is injected with the default types (latest Polkadot and Substrate master types). The tool was built with user friendliness in mind, without excluding cool and useful features like phone calls for critical alerts and Telegram commands for increased control over your alerter.
66

@@ -10,11 +10,11 @@ We are sure that PANIC will be beneficial for node operators in the Polkadot com
1010

1111
## Design and Features
1212

13-
To be able to monitor and alert, PANIC was designed to retrieve data from Polkadot nodes using a custom-built JavaScript (JS) API. The JS API is an intermediate component which interacts with the Polkadot nodes via the [polkadot-js/api](https://polkadot.js.org/api/). For more details on the JS API please [read this](api/README.md). If you want to dive into the design and feature set of PANIC [click here](alerter/doc/DESIGN_AND_FEATURES.md).
13+
To be able to monitor and alert, PANIC was designed to retrieve data from Polkadot nodes using a custom-built [Polkadot API Server](https://github.com/SimplyVC/polkadot_api_server). The API Server is an intermediate component which interacts with the Polkadot nodes via the [polkadot-js/api](https://polkadot.js.org/api/). For more details on the API Server please refer to the [Polkadot API Server repository](https://github.com/SimplyVC/polkadot_api_server). If you want to dive into the design and feature set of PANIC [click here](doc/DESIGN_AND_FEATURES.md).
1414

1515
## Ready, Set, Alert!
1616

17-
PANIC is highly dependent on the JS API for correct execution. Therefore, if you are ready to try out PANIC on your Polkadot nodes, you should first setup and run the JS API on **ALL** nodes you want to monitor using [this guide](api/doc/INSTALL_AND_RUN.md). After the JS API is successfully running, you should set up and run the alerter using [this guide](alerter/doc/INSTALL_AND_RUN.md).
17+
PANIC is highly dependent on the [Polkadot API Server](https://github.com/SimplyVC/polkadot_api_server) for correct execution. Therefore, if you are ready to try out PANIC on your Polkadot nodes, you should first setup and run the API Server, and connect it to **ALL** nodes you want to monitor using the guides found inside the [Polkadot API Server repository](https://github.com/SimplyVC/polkadot_api_server). After the API Server is successfully running, you should set up and run the alerter using [this guide](doc/INSTALL_AND_RUN.md).
1818

1919
## Support and Contribution
2020

@@ -28,4 +28,4 @@ Simply VC runs highly reliable and secure infrastructure in our own datacentre i
2828

2929
---
3030

31-
Official PANIC for Polkadot image adapted from [slidescarnival.com](https://www.slidescarnival.com/)
31+
Official PANIC for Polkadot image adapted from [slidescarnival.com](https://www.slidescarnival.com/)

alerter/doc/CHANGELOG.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

alerter/doc/IMG_PANIC.png

-190 KB
Binary file not shown.
-21.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)