httpcheck

README

HTTP endpoint collector

This module monitors one or more http servers availability and response time.

Metrics

All metrics have "httpcheck." prefix.

Labels per scope:

• global: url.

Metric	Scope	Dimensions	Units
response_time	global	time	ms
response_length	global	length	characters
status	global	success, no_connection, timeout, bad_content, bad_status	boolean

Check statuses

Status	Description
success	No error on HTTP request, body reading and body content checking
timeout	Timeout error on HTTP request
bad content	The body of the response didn't match the regex (only if response_match option is set)
bad status	Response status code not in status_accepted
no connection	Any other network error not specifically handled by the module

Configuration

Edit the go.d/httpcheck.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/httpcheck.conf

Here is an example for 2 servers:

jobs:
  - name: cool_website1
    url: http://cool.website1:8080/home

  - name: cool_website2
    url: http://cool.website2:8080/home
    status_accepted:
      - 200
      - 201
      - 202
    response_match: <title>My cool website!<\/title>

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the httpcheck collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m httpcheck
  

Documentation

Index

• type Config
• type HTTPCheck
  • func New() *HTTPCheck
  • func (hc *HTTPCheck) Charts() *module.Charts
  • func (hc *HTTPCheck) Check() bool
  • func (hc *HTTPCheck) Cleanup()
  • func (hc *HTTPCheck) Collect() map[string]int64
  • func (hc *HTTPCheck) Init() bool

Types

type Config

type Config struct {
	web.HTTP         `yaml:",inline"`
	AcceptedStatuses []int  `yaml:"status_accepted"`
	ResponseMatch    string `yaml:"response_match"`
}

type HTTPCheck

type HTTPCheck struct {
	module.Base
	Config      `yaml:",inline"`
	UpdateEvery int `yaml:"update_every"`
	// contains filtered or unexported fields
}

func New

func New() *HTTPCheck

func (*HTTPCheck) Charts

func (hc *HTTPCheck) Charts() *module.Charts

func (*HTTPCheck) Check

func (hc *HTTPCheck) Check() bool

func (*HTTPCheck) Cleanup

func (hc *HTTPCheck) Cleanup()

func (*HTTPCheck) Collect

func (hc *HTTPCheck) Collect() map[string]int64

func (*HTTPCheck) Init

func (hc *HTTPCheck) Init() bool