summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/portcheck/README.md
blob: f1338d5768e45fc2020581e684f8c31a3f1c4c59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# portcheck

Module monitors a remote TCP service.

Following charts are drawn per host:

1. **Latency** ms
 * Time required to connect to a TCP port.
   Displays latency in 0.1 ms resolution. If the connection failed, the value is missing.

2. **Status** boolean
 * Connection successful
 * Could not create socket: possible DNS problems
 * Connection refused: port not listening or blocked
 * Connection timed out: host or port unreachable


### configuration

```yaml
server:
  host: 'dns or ip'     # required
  port: 22              # required
  timeout: 1            # optional
  update_every: 1       # optional
```

### notes

 * The error chart is intended for alarms, badges or for access via API.
 * A system/service/firewall might block netdata's access if a portscan or
   similar is detected.
 * Currently, the accuracy of the latency is low and should be used as reference only.

---