providers

Documentation

Overview

Package providers defines a common API for providers.

Index

• Constants
• type Env
• type Provider

Constants

const (
	Local  = "local"  // running as local process
	Kube   = "kube"   // running in Kubernetes pod
	Docker = "docker" // running in Docker container
)

Types

type Env

type Env string

type Provider

type Provider interface {
	// Env returns the environment type of the provider.
	Env() string

	// Name returns a name of the provider.
	Name() string

	// Query runs query with list of parameters used as filters and returns a list
	// of Handler for
	Query(params ...map[string]string) ([]probe.Handler, error)
}

Provider provides ways to discover instances.