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

fixed typos #40

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Use `APIServer: Enabled: true` to turn on in in config-{cluster}.yaml.

### PingService
This is similar to "solana ping" tool in solana tool but can do concurrent rpc query.
It send transactions to rpc endpoint and wait for transactions is confirmed.
It sends transactions to rpc endpoint and wait for transactions is confirmed.
Use `PingServiceEnabled: true` to turn on in config-{cluster}.yaml.
### RetensionService
Use `Retension: Enabled: true` in config.yaml to turn on. Default is Off.
Clean database data periodically.

### ReportService
Use `Report: Enabled:true` in config-{cluster}.yaml to turn on.
ping-api service supports sedning report & alert to both slack and discord.
ping-api service supports sending report & alert to both slack and discord.
Use `Report: Slack: Report: Enabled:true` to turn on Slack Report.
This sends summary of ping result to a slack channel periodically.
Use `Report: Slack: Alert: Enabled:true` to turn on Slack Alert.
Expand Down Expand Up @@ -99,12 +99,12 @@ WantedBy=multi-user.target
- put executable file in ~/ping-api-server
- cp config.yaml.samle to ~/ping-api-server/config.yaml and modify it
- use cp-to-real-config.sh to copy config.yaml to ~/.config/ping-api/config.yaml
- start service by sudo sysmtemctl start solana-ping-api.service
- start service by `sudo sysmtemctl start solana-ping-api.service`
- you can check log by ```sudo tail -f /var/log/syslog | grep ping-api```

## Alert Spam Filter

Alert Spam Filter could be changed frequently. The updte to date (4/18/2022) setting is as below.
Alert Spam Filter could be changed frequently. The update to date (4/18/2022) setting is as below.
```
Threshold increases when
Loss > 20 % -> new threshold = 50% -> send alert
Expand All @@ -114,4 +114,4 @@ Alert Spam Filter could be changed frequently. The updte to date (4/18/2022) set
Loss > 75 % to < 75% -> new threshold = 75% -> send alert
Loss > 50 % to < 50% -> new threshold = 50% -> send alert
Loss > 20 % to < 20% -> new threshold = 20% -> NOT send alert
```
```