http

Documentation

Overview

Package http is the HTTP probe package.

Index

• type HTTP
  • func (h *HTTP) Config(gConf global.ProbeSettings) error
  • func (h *HTTP) DoProbe() (bool, string)
  • func (h *HTTP) ExportMetrics(resp *http.Response)
• type TraceStats
  • func NewTraceStats(kind, tag, name string) *TraceStats
  • func (s *TraceStats) Done()
  • func (s *TraceStats) Report()

Types

type HTTP

type HTTP struct {
	base.DefaultProbe `yaml:",inline"`
	URL               string            `yaml:"url" json:"url" jsonschema:"format=uri,title=HTTP URL,description=HTTP URL to probe"`
	Proxy             string            `yaml:"proxy" json:"proxy,omitempty" jsonschema:"format=url,title=Proxy Server,description=proxy to use for HTTP requests"`
	ContentEncoding   string            `` /* 157-byte string literal not displayed */
	Method            string            `` /* 225-byte string literal not displayed */
	Headers           map[string]string `` /* 131-byte string literal not displayed */
	Body              string            `yaml:"body,omitempty" json:"body,omitempty" jsonschema:"title=HTTP Body,description=HTTP body to use for HTTP requests"`

	// Output Text Checker
	probe.TextChecker `yaml:",inline"`

	// Evaluator
	Evaluator eval.Evaluator `` /* 129-byte string literal not displayed */

	// Option - HTTP Basic Auth Credentials
	User string `` /* 132-byte string literal not displayed */
	Pass string `` /* 132-byte string literal not displayed */

	// Option - Preferred HTTP response code ranges
	// If not set, default is [0, 499].
	SuccessCode [][]int `` /* 190-byte string literal not displayed */

	// Option - TLS Config
	global.TLS `yaml:",inline"`
	// contains filtered or unexported fields
}

HTTP implements a config for HTTP.

func (*HTTP) Config

func (h *HTTP) Config(gConf global.ProbeSettings) error

Config HTTP Config Object

func (*HTTP) DoProbe

func (h *HTTP) DoProbe() (bool, string)

DoProbe return the checking result

func (*HTTP) ExportMetrics

func (h *HTTP) ExportMetrics(resp *http.Response)

ExportMetrics export HTTP metrics

type TraceStats

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

TraceStats is the stats for a http request

func NewTraceStats

func NewTraceStats(kind, tag, name string) *TraceStats

NewTraceStats returns a new traceSTats.

func (*TraceStats) Done

func (s *TraceStats) Done()

Done function is used to finish the trace manually

func (*TraceStats) Report

func (s *TraceStats) Report()

Report show the trace stats