telegraf/plugins/inputs/httpjson/httpjson.go

296 lines
6.6 KiB
Go
Raw Normal View History

2015-08-04 21:48:13 +00:00
package httpjson
import (
"bytes"
2015-08-04 21:48:13 +00:00
"fmt"
2015-08-14 21:33:51 +00:00
"io/ioutil"
2015-08-04 21:48:13 +00:00
"net/http"
2015-08-14 21:33:51 +00:00
"net/url"
"strings"
2015-08-04 21:48:13 +00:00
"sync"
"time"
2015-08-14 21:33:51 +00:00
"github.com/influxdata/telegraf"
"github.com/influxdata/telegraf/internal"
2018-05-04 23:33:23 +00:00
"github.com/influxdata/telegraf/internal/tls"
2016-01-20 18:57:35 +00:00
"github.com/influxdata/telegraf/plugins/inputs"
"github.com/influxdata/telegraf/plugins/parsers"
2015-08-04 21:48:13 +00:00
)
var (
utf8BOM = []byte("\xef\xbb\xbf")
)
// HttpJson struct
2015-08-04 21:48:13 +00:00
type HttpJson struct {
Name string
Servers []string
Method string
TagKeys []string
ResponseTimeout internal.Duration
Parameters map[string]string
Headers map[string]string
2018-05-04 23:33:23 +00:00
tls.ClientConfig
client HTTPClient
2015-08-14 21:33:51 +00:00
}
type HTTPClient interface {
// Returns the result of an http request
//
// Parameters:
// req: HTTP request object
//
// Returns:
// http.Response: HTTP response object
2015-08-14 21:33:51 +00:00
// error : Any error that may have occurred
MakeRequest(req *http.Request) (*http.Response, error)
SetHTTPClient(client *http.Client)
HTTPClient() *http.Client
2015-08-14 21:33:51 +00:00
}
type RealHTTPClient struct {
client *http.Client
}
func (c *RealHTTPClient) MakeRequest(req *http.Request) (*http.Response, error) {
2015-08-14 21:33:51 +00:00
return c.client.Do(req)
2015-08-04 21:48:13 +00:00
}
func (c *RealHTTPClient) SetHTTPClient(client *http.Client) {
c.client = client
}
func (c *RealHTTPClient) HTTPClient() *http.Client {
return c.client
}
2015-08-04 21:48:13 +00:00
var sampleConfig = `
## NOTE This plugin only reads numerical measurements, strings and booleans
## will be ignored.
## Name for the service being polled. Will be appended to the name of the
## measurement e.g. httpjson_webserver_stats
##
## Deprecated (1.3.0): Use name_override, name_suffix, name_prefix instead.
name = "webserver_stats"
## URL of each server in the service's cluster
servers = [
"http://localhost:9999/stats/",
"http://localhost:9998/stats/",
]
## Set response_timeout (default 5 seconds)
response_timeout = "5s"
## HTTP method to use: GET or POST (case-sensitive)
method = "GET"
## List of tag names to extract from top-level of JSON server response
# tag_keys = [
# "my_tag_1",
# "my_tag_2"
# ]
2018-05-04 23:33:23 +00:00
## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
# tls_cert = "/etc/telegraf/cert.pem"
# tls_key = "/etc/telegraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = false
## HTTP parameters (all values must be strings). For "GET" requests, data
## will be included in the query. For "POST" requests, data will be included
## in the request body as "x-www-form-urlencoded".
# [inputs.httpjson.parameters]
# event_type = "cpu_spike"
# threshold = "0.75"
## HTTP Headers (all values must be strings)
# [inputs.httpjson.headers]
# X-Auth-Token = "my-xauth-token"
# apiVersion = "v1"
2015-08-04 21:48:13 +00:00
`
func (h *HttpJson) SampleConfig() string {
return sampleConfig
}
func (h *HttpJson) Description() string {
return "Read flattened metrics from one or more JSON HTTP endpoints"
}
2015-08-14 21:33:51 +00:00
// Gathers data for all servers.
func (h *HttpJson) Gather(acc telegraf.Accumulator) error {
2015-08-04 21:48:13 +00:00
var wg sync.WaitGroup
if h.client.HTTPClient() == nil {
2018-05-04 23:33:23 +00:00
tlsCfg, err := h.ClientConfig.TLSConfig()
if err != nil {
return err
}
tr := &http.Transport{
ResponseHeaderTimeout: h.ResponseTimeout.Duration,
TLSClientConfig: tlsCfg,
}
client := &http.Client{
Transport: tr,
Timeout: h.ResponseTimeout.Duration,
}
h.client.SetHTTPClient(client)
}
for _, server := range h.Servers {
wg.Add(1)
go func(server string) {
defer wg.Done()
2017-04-24 18:13:26 +00:00
acc.AddError(h.gatherServer(acc, server))
}(server)
2015-08-04 21:48:13 +00:00
}
wg.Wait()
2015-08-14 21:33:51 +00:00
2017-04-24 18:13:26 +00:00
return nil
2015-08-04 21:48:13 +00:00
}
2015-08-14 21:33:51 +00:00
// Gathers data from a particular server
// Parameters:
// acc : The telegraf Accumulator to use
// serverURL: endpoint to send request to
// service : the service being queried
//
// Returns:
// error: Any error that may have occurred
func (h *HttpJson) gatherServer(
acc telegraf.Accumulator,
serverURL string,
) error {
resp, responseTime, err := h.sendRequest(serverURL)
2015-08-04 21:48:13 +00:00
if err != nil {
return err
}
var msrmnt_name string
if h.Name == "" {
msrmnt_name = "httpjson"
} else {
msrmnt_name = "httpjson_" + h.Name
2015-08-14 21:33:51 +00:00
}
tags := map[string]string{
"server": serverURL,
2015-08-04 21:48:13 +00:00
}
parser, err := parsers.NewParser(&parsers.Config{
DataFormat: "json",
MetricName: msrmnt_name,
TagKeys: h.TagKeys,
DefaultTags: tags,
})
if err != nil {
return err
2015-10-16 14:10:08 +00:00
}
metrics, err := parser.Parse([]byte(resp))
2015-12-14 22:57:17 +00:00
if err != nil {
return err
}
for _, metric := range metrics {
fields := make(map[string]interface{})
for k, v := range metric.Fields() {
fields[k] = v
}
fields["response_time"] = responseTime
acc.AddFields(metric.Name(), fields, metric.Tags())
2015-12-14 22:57:17 +00:00
}
2015-08-14 21:33:51 +00:00
return nil
}
2015-08-04 21:48:13 +00:00
// Sends an HTTP request to the server using the HttpJson object's HTTPClient.
// This request can be either a GET or a POST.
2015-08-14 21:33:51 +00:00
// Parameters:
// serverURL: endpoint to send request to
//
// Returns:
// string: body of the response
// error : Any error that may have occurred
func (h *HttpJson) sendRequest(serverURL string) (string, float64, error) {
2015-08-14 21:33:51 +00:00
// Prepare URL
requestURL, err := url.Parse(serverURL)
2015-08-04 21:48:13 +00:00
if err != nil {
return "", -1, fmt.Errorf("Invalid server URL \"%s\"", serverURL)
2015-08-04 21:48:13 +00:00
}
data := url.Values{}
switch {
case h.Method == "GET":
params := requestURL.Query()
for k, v := range h.Parameters {
params.Add(k, v)
}
requestURL.RawQuery = params.Encode()
case h.Method == "POST":
requestURL.RawQuery = ""
for k, v := range h.Parameters {
data.Add(k, v)
}
2015-08-14 21:33:51 +00:00
}
// Create + send request
req, err := http.NewRequest(h.Method, requestURL.String(),
strings.NewReader(data.Encode()))
2015-08-14 21:33:51 +00:00
if err != nil {
return "", -1, err
2015-08-14 21:33:51 +00:00
}
// Add header parameters
for k, v := range h.Headers {
if strings.ToLower(k) == "host" {
req.Host = v
} else {
req.Header.Add(k, v)
}
}
start := time.Now()
2015-08-14 21:33:51 +00:00
resp, err := h.client.MakeRequest(req)
if err != nil {
return "", -1, err
2015-08-14 21:33:51 +00:00
}
defer resp.Body.Close()
responseTime := time.Since(start).Seconds()
2015-08-14 21:33:51 +00:00
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return string(body), responseTime, err
2015-08-04 21:48:13 +00:00
}
body = bytes.TrimPrefix(body, utf8BOM)
2015-08-04 21:48:13 +00:00
2015-08-14 21:33:51 +00:00
// Process response
if resp.StatusCode != http.StatusOK {
err = fmt.Errorf("Response from url \"%s\" has status code %d (%s), expected %d (%s)",
requestURL.String(),
resp.StatusCode,
http.StatusText(resp.StatusCode),
http.StatusOK,
http.StatusText(http.StatusOK))
return string(body), responseTime, err
2015-08-14 21:33:51 +00:00
}
return string(body), responseTime, err
2015-08-04 21:48:13 +00:00
}
func init() {
inputs.Add("httpjson", func() telegraf.Input {
return &HttpJson{
client: &RealHTTPClient{},
ResponseTimeout: internal.Duration{
Duration: 5 * time.Second,
},
}
2015-08-04 21:48:13 +00:00
})
}