probe

Documentation

Overview

Package probe implements the K8s readiness and liveliness probe handlers.

Index

• type Deps
• type Plugin
  • func (p *Plugin) AfterInit() error
  • func (p *Plugin) Close() error
  • func (p *Plugin) Init() (err error)
  • func (p *Plugin) String() string

Types

type Deps

type Deps struct {
	local.PluginLogDeps                               //inject
	HTTP                *rest.Plugin                  //inject optionally
	StatusCheck         statuscheck.AgentStatusReader //inject
}

Deps is here to group injected dependencies of plugin to not mix with other plugin fields.

type Plugin

type Plugin struct {
	Deps
	// contains filtered or unexported fields
}

Plugin struct holds all plugin-related data

func (*Plugin) AfterInit

func (p *Plugin) AfterInit() error

AfterInit is called by the Agent Core after all plugins have been initialized.

func (*Plugin) Close

func (p *Plugin) Close() error

Close is called by the Agent Core when it's time to clean up the plugin

func (*Plugin) Init

func (p *Plugin) Init() (err error)

Init is the plugin entry point called by the Agent Core

func (*Plugin) String

func (p *Plugin) String() string

String returns plugin name if it is set