httpjson

README

HTTP JSON Plugin

The httpjson plugin can collect data from remote URLs which respond with JSON. Then it flattens JSON and finds all numeric values, treating them as floats.

For example, if you have a service called mycollector, which has HTTP endpoint for gathering stats at http://my.service.com/_stats, you would configure the HTTP JSON plugin like this:

[[httpjson.services]]
  name = "mycollector"

  servers = [
    "http://my.service.com/_stats"
  ]

  # HTTP method to use (case-sensitive)
  method = "GET"

name is used as a prefix for the measurements.

method specifies HTTP method to use for requests.

You can also specify which keys from server response should be considered tags:

[[httpjson.services]]
  ...

  tag_keys = [
    "role",
    "version"
  ]

You can also specify additional request parameters for the service:

[[httpjson.services]]
  ...

 [httpjson.services.parameters]
    event_type = "cpu_spike"
    threshold = "0.75"

Example:

Let's say that we have a service named "mycollector" configured like this:

[httpjson]
  [[httpjson.services]]
    name = "mycollector"

    servers = [
      "http://my.service.com/_stats"
    ]

    # HTTP method to use (case-sensitive)
    method = "GET"

    tag_keys = ["service"]

which responds with the following JSON:

{
    "service": "service01",
    "a": 0.5,
    "b": {
        "c": "some text",
        "d": 0.1,
        "e": 5
    }
}

The collected metrics will be:

httpjson_mycollector_a,service='service01',server='http://my.service.com/_stats' value=0.5
httpjson_mycollector_b_d,service='service01',server='http://my.service.com/_stats' value=0.1
httpjson_mycollector_b_e,service='service01',server='http://my.service.com/_stats' value=5

Example 2, Multiple Services:

There is also the option to collect JSON from multiple services, here is an example doing that.

[httpjson]
  [[httpjson.services]]
    name = "mycollector1"

    servers = [
      "http://my.service1.com/_stats"
    ]

    # HTTP method to use (case-sensitive)
    method = "GET"

  [[httpjson.services]]
    name = "mycollector2"

    servers = [
      "http://service.net/json/stats"
    ]

    # HTTP method to use (case-sensitive)
    method = "POST"

The services respond with the following JSON:

mycollector1:

{
    "a": 0.5,
    "b": {
        "c": "some text",
        "d": 0.1,
        "e": 5
    }
}

mycollector2:

{
    "load": 100,
    "users": 1335
}

The collected metrics will be:

httpjson_mycollector1_a,server='http://my.service.com/_stats' value=0.5
httpjson_mycollector1_b_d,server='http://my.service.com/_stats' value=0.1
httpjson_mycollector1_b_e,server='http://my.service.com/_stats' value=5

httpjson_mycollector2_load,server='http://service.net/json/stats' value=100
httpjson_mycollector2_users,server='http://service.net/json/stats' value=1335

Documentation

Index

• type HTTPClient
• type HttpJson
  • func (h *HttpJson) Description() string
  • func (h *HttpJson) Gather(acc plugins.Accumulator) error
  • func (h *HttpJson) SampleConfig() string
• type RealHTTPClient
  • func (c RealHTTPClient) MakeRequest(req *http.Request) (*http.Response, error)
• type Service

Types

type HTTPClient

type HTTPClient interface {
	// Returns the result of an http request
	//
	// Parameters:
	// req: HTTP request object
	//
	// Returns:
	// http.Response:  HTTP respons object
	// error        :  Any error that may have occurred
	MakeRequest(req *http.Request) (*http.Response, error)
}

type HttpJson

type HttpJson struct {
	Services []Service
	// contains filtered or unexported fields
}

func (*HttpJson) Description

func (h *HttpJson) Description() string

func (*HttpJson) Gather

func (h *HttpJson) Gather(acc plugins.Accumulator) error

Gathers data for all servers.

func (*HttpJson) SampleConfig

func (h *HttpJson) SampleConfig() string

type RealHTTPClient

type RealHTTPClient struct {
	// contains filtered or unexported fields
}

func (RealHTTPClient) MakeRequest

func (c RealHTTPClient) MakeRequest(req *http.Request) (*http.Response, error)

type Service

type Service struct {
	Name       string
	Servers    []string
	Method     string
	TagKeys    []string
	Parameters map[string]string
}