probes

Documentation

Overview

Package probes provides an interface to initialize probes using prober config.

Index

• Variables
• func Init(probeProtobufs []*configpb.ProbeDef, ...) (map[string]*ProbeInfo, error)
• func RegisterProbeType(extensionFieldNo int, newProbeFunc func() Probe)
• func RegisterUserDefined(name string, probe Probe)
• type Probe
• type ProbeInfo

Variables

var StatusTmpl = template.Must(template.New("statusTmpl").Parse(`
<table class="status-list">
  <tr>
    <th>Name</th>
    <th>Type</th>
    <th>Interval</th>
    <th>Timeout</th>
    <th width="20%%">Targets</th>
    <th width="30%%">Probe Conf</th>
    <th>Latency Unit</th>
    <th>Latency Distribution Lower Bounds (if configured) </th>
  </tr>
  {{ range . }}
  <tr>
    <td>{{.Name}}</td>
    <td>{{.Type}}</td>
    <td>{{.Interval}}</td>
    <td>{{.Timeout}}</td>
    <td><pre>{{.TargetsDesc}}</pre></td>

    <td>
    {{if .ProbeConf}}
      <pre>{{.ProbeConf}}</pre>
    {{else}}
      default
    {{end}}
    </td>

    <td>{{.LatencyUnit}}</td>
    <td><pre>{{.LatencyDistLB}}</pre></td>
  </tr>
  {{ end }}
</table>
`))

StatusTmpl variable stores the HTML template suitable to generate the probes' status for cloudprober's /status page. It expects an array of ProbeInfo objects as input.

Functions

func Init

func Init(probeProtobufs []*configpb.ProbeDef, globalTargetsOpts *targetspb.GlobalTargetsOptions, l *logger.Logger, sysVars map[string]string) (map[string]*ProbeInfo, error)

Init initializes the probes defined in the config.

func RegisterProbeType

func RegisterProbeType(extensionFieldNo int, newProbeFunc func() Probe)

RegisterProbeType registers a new probe-type. New probe types are integrated with the config subsystem using the protobuf extensions.

TODO(manugarg): Add a full example of using extensions.

func RegisterUserDefined

func RegisterUserDefined(name string, probe Probe)

RegisterUserDefined allows you to register a user defined probe with cloudprober. Example usage:

import (
	"github.com/google/cloudprober"
	"github.com/google/cloudprober/probes"
)

p := &FancyProbe{}
probes.RegisterUserDefined("fancy_probe", p)
pr, err := cloudprober.InitFromConfig(*configFile)
if err != nil {
	log.Exitf("Error initializing cloudprober. Err: %v", err)
}

Types

type Probe

type Probe interface {
	Init(name string, opts *options.Options) error
	Start(ctx context.Context, dataChan chan *metrics.EventMetrics)
}

Probe interface represents a probe.

A probe is initilized using the Init() method. Init takes the name of the probe and probe options.

Start() method starts the probe. Start is not expected to return for the lifetime of the prober. It takes a data channel that it writes the probe results on. Actual publishing of these results is handled by cloudprober itself.

type ProbeInfo

type ProbeInfo struct {
	Probe
	Name          string
	Type          string
	Interval      string
	Timeout       string
	TargetsDesc   string
	LatencyDistLB string
	LatencyUnit   string
	ProbeConf     string
}

ProbeInfo encapsulates the probe and associated information.