Add documentation for httpcheck
Chris committed
Feb 20, 2018 at 19:15 UTC
dd0d86b0f2603e4d0f98efa1e6fb513d7c604b2f
1 file changed
+44
python.d/README.md
+44
@@ -853,6 +853,50 @@ If no configuration is given, module will attempt to connect to hddtemp daemon o
853
854
---
855
856
+# httpcheck
857
+
858
+Module monitors remote http server for availability and response time.
859
+
860
+Following charts are drawn per job:
861
+
862
+1. **Response time** ms
863
+ * Time in 0.1 ms resolution in which the server responds. When connection is successful,
864
+ it will be at least 0.1 ms, even if the measured time is lower than 0.1 ms.
865
+ If it is 0.0 ms, the connection failed with error code >=3 (useful for API)
866
+
867
+2. **Error code** int
868
+ * One of:
869
+ - 0: Connection successful
870
+ - 1: Content does not satisfy regex pattern.
871
+ - 2: HTTP status code not accepted
872
+ - 3: Connection failed (port not listening or blocked)
873
+ - 4: Connection timed out (host unreachable?)
874
+
875
+### configuration
876
+
877
+Sample configuration and their default values.
878
+
879
+```yaml
880
+server:
881
+ url: 'http://host:port/path' # required
882
+ status_accepted: # optional
883
+ - 200
884
+ request_timeout: 1 # optional
885
+ update_every: 1 # optional
886
+ regex: '.*' # optional
887
+ redirect: yes # optional
888
+```
889
+
890
+### notes
891
+
892
+ * The error code chart is intended for health check or for access via API.
893
+ * A system/service/firewall might block netdata's access if a portscan or
894
+ similar is detected.
895
+ * This plugin is meant for simple use cases. For monitoring large networks
896
+ consider a real service monitoring tool.
897
+
898
+---
899
+
900
# IPFS
901
902
Module monitors [IPFS](https://ipfs.io) basic information.