Skip to content
This repository was archived by the owner on Apr 28, 2022. It is now read-only.

Commit 1cd40ea

Browse files
SimplyVCSimplyVC
authored andcommitted
Initial commit.
0 parents  commit 1cd40ea

100 files changed

Lines changed: 7327 additions & 0 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.

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.idea/
2+
__pycache__/
3+
4+
logs/*.log
5+
logs/*/*.log
6+
!logs/alerts/.gitkeep
7+
!logs/general/.gitkeep
8+
9+
config/user_config_main.ini
10+
config/user_config_nodes.ini
11+
config/user_config_repos.ini
12+
13+
.coverage

LICENSE

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

Pipfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[[source]]
2+
name = "pypi"
3+
url = "https://pypi.org/simple"
4+
verify_ssl = true
5+
6+
[dev-packages]
7+
coverage = "*"
8+
9+
[packages]
10+
requests = "*"
11+
configparser = "*"
12+
twilio = "*"
13+
python-telegram-bot = "*"
14+
python-dateutil = "*"
15+
redis = "*"

Pipfile.lock

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

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# P.A.N.I.C. by Simply VC
2+
3+
<img src="./doc/IMG_PANIC.png" alt="design" width="600"/>
4+
5+
P.A.N.I.C. (Python Alerter for Nodes In Cosmos) by [Simply VC](https://simply-vc.com.mt/) is a powerful and lightweight open source monitoring and alerting solution for [Cosmos](https://cosmos.network/) nodes. It is compatible with any chain built using the Cosmos SDK. The tool was built with user friendliness in mind, without excluding cool and useful features like phone calls for major alerts and Telegram commands for increased control over your alerter.
6+
7+
The alerter's focus on a modular design means that it is beginner friendly but also developer friendly. It allows the user to decide which components of the alerter to set up while making it easy for developers to add new features. P.A.N.I.C. also offers two levels of configurability, _user_ and _internal_, allowing more experienced users to fine-tune the alerter to their preference.
8+
9+
We are sure that P.A.N.I.C. will be beneficial for node operators in the Cosmos community and we look forward to feedback. Feel free to read on if you are interested in the design of the alerter, if you wish to try it out, or if you would like to support and contribute to this open source project, or just check out upcoming features.
10+
11+
### Design and Features
12+
13+
[Click here](doc/DESIGN_AND_FEATURES.md) if you want to dive into the design and feature set of P.A.N.I.C.
14+
15+
### Ready, Set, Alert!
16+
17+
[Click here](doc/INSTALL_AND_RUN.md) if you are ready to try out P.A.N.I.C. on your Cosmos nodes!
18+
19+
### Support and Contribution
20+
21+
On top of the additional work that we will put in ourselves to improve and maintain the tool, any support from the community, both through development work or by delegating to the [Simply VC validator](https://simply-vc.com.mt/cosmos), will be greatly appreciated.
22+
23+
[Click here](doc/TODO.md) for a list of pending features and improvements if you are interested in helping out or want to check out what's in the pipeline!
24+
25+
### Who We Are
26+
Simply VC runs highly reliable and secure infrastructure in our own datacentre in Malta, built with the aim of supporting the growth of the blockchain ecosystem. Read more about us on our website and Twitter:
27+
28+
- Simply VC website: <https://simply-vc.com.mt/>
29+
- Simply VC Twitter: <https://twitter.com/Simply_VC>
30+
31+
### Further Reading
32+
33+
If you wish to read more about monitoring and alerting on Cosmos, check out [our article on Medium](<https://medium.com/simply-vc/cosmos-monitoring-and-alerting-for-validators-8e3f016c9567>).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[general]
2+
unique_alerter_identifier = cosmoshub-2-alerter
3+
4+
[telegram_alerts]
5+
enabled = True
6+
bot_token = 123456789:ABCDEF-1234abcd5678efgh12345_abc123
7+
bot_chat_id = 123456789
8+
9+
[email_alerts]
10+
enabled = True
11+
smtp = my.smtp.com
12+
from = alerter@email.com
13+
to = user@email.com
14+
15+
[twilio_alerts]
16+
enabled = True
17+
account_sid = abcd1234efgh5678ABCD1234EFGH567890
18+
auth_token = 1234abcd5678efgh1234abcd5678efgh
19+
twilio_phone_number = +12025551234
20+
phone_numbers_to_dial = +12025551235;+12025551236;+12025551237
21+
22+
[telegram_commands]
23+
enabled = True
24+
bot_token = 123456789:ABCDEF-1234abcd5678efgh12345_abc123
25+
bot_chat_id = 123456789
26+
27+
[redis]
28+
enabled = True
29+
host = localhost
30+
port = 6379
31+
password = HMASDNoiSADnuiasdgnAIO876hg967bv99vb8buyT8BVuyT76VBT76uyi
32+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[node_1]
2+
node_name = Validator
3+
node_rpc_url = http://11.22.33.11:26657
4+
node_is_validator = true
5+
include_in_node_monitor = true
6+
include_in_network_monitor = true
7+
8+
[node_2]
9+
node_name = Sentry 1
10+
node_rpc_url = http://11.22.33.22:26657
11+
node_is_validator = false
12+
include_in_node_monitor = true
13+
include_in_network_monitor = false
14+
15+
[node_3]
16+
node_name = Sentry 2
17+
node_rpc_url = http://11.22.33.33:26657
18+
node_is_validator = false
19+
include_in_node_monitor = false
20+
include_in_network_monitor = true
21+
22+
[node_4]
23+
node_name = Sentry 2
24+
node_rpc_url = http://11.22.33.44:26657
25+
node_is_validator = false
26+
include_in_node_monitor = false
27+
include_in_network_monitor = false
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[repo_1]
2+
repo_name = Cosmos SDK
3+
repo_page = cosmos/cosmos-sdk/
4+
include_in_github_monitor = true
5+
6+
[repo_2]
7+
repo_name = Gaia
8+
repo_page = cosmos/gaia/
9+
include_in_github_monitor = false

0 commit comments

Comments
 (0)