Skip to content

Commit f496610

Browse files
committed
format README
1 parent 24f3dfb commit f496610

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

check-ping/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,47 @@
11
# check-ping
22

33
## Description
4+
45
Check ICMP Ping connections with the specified host.
56

67
## Synopsis
7-
```
8+
9+
```bash
810
check-ping -H 127.0.0.1 -n 5 -w 100
911
```
1012

1113
## Installation
1214

1315
First, build this program.
1416

15-
```
17+
```bash
1618
go get github.com/mackerelio/go-check-plugins
1719
cd $(go env GOPATH)/src/github.com/mackerelio/go-check-plugins/check-ping
1820
go install
1921
```
2022

2123
Or you can use this program by installing the official Mackerel package. See [Using the official check plugin pack for check monitoring - Mackerel Docs](https://mackerel.io/docs/entry/howto/mackerel-check-plugins).
2224

23-
2425
Next, you can execute this program :-)
2526

26-
```
27+
```bash
2728
check-ping -H 127.0.0.1 -n 5 -w 100
2829
```
2930

30-
3131
## Setting for mackerel-agent
3232

33-
If there are no problems in the execution result, add a setting in mackerel-agent.conf .
33+
If there are no problems in the execution result, add a setting in mackerel-agent.conf.
3434

35-
```
35+
```toml
3636
[plugin.checks.check-ping-sample]
3737
command = ["check-ping", "-H", "127.0.0.1", "-n", "5", "-w", "100"]
3838
```
3939

4040
## Usage
41+
4142
### Options
4243

43-
```
44+
```text
4445
-H, --host= check target IP Address
4546
-n, --count= sending (and receiving) count ping packets (default: 1)
4647
-w, --wait-time= wait time, Max RTT(ms) (default: 1000)

0 commit comments

Comments
 (0)