httpcheck

README

HTTP endpoint monitoring with Netdata

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

Charts

It produces the following charts:

• HTTP Response Time in ms
• HTTP Check Status in boolean
• HTTP Current State Duration in seconds
• HTTP Response Body Length in characters

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.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

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

Documentation

Index

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

Types

type Chart

type Chart = module.Chart

Chart is an alias for module.Chart

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

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

Config is the HTTPCheck module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type HTTPCheck

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

HTTPCheck HTTPCheck module.

func New

func New() *HTTPCheck

New creates HTTPCheck with default values.

func (HTTPCheck) Charts

func (hc HTTPCheck) Charts() *Charts

Charts creates Charts

func (*HTTPCheck) Check

func (hc *HTTPCheck) Check() bool

Check makes check.

func (HTTPCheck) Cleanup

func (HTTPCheck) Cleanup()

Cleanup makes cleanup.

func (*HTTPCheck) Collect

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

Collect collects metrics

func (*HTTPCheck) Init

func (hc *HTTPCheck) Init() bool

Init makes initialization