scoutclient

package

Go to main page

Versions in this module

v0

v0.29.4

Sep 1, 2024

v0.29.3

Jul 29, 2024

v0.29.2

Jul 29, 2024

v0.29.1

Jul 17, 2024

v0.29.0

Jul 17, 2024

v0.28.0

Feb 3, 2024

v0.27.0

Mar 22, 2023

v0.26.2

Nov 7, 2022

Changes in this version

type GossValidateOutput

+ func (d *GossValidateOutput) Skipped() int64

type GossValidateRequester

+ func (d *GossValidateRequester) File(v string) *GossValidateRequester

+ func (d *GossValidateRequester) YamlRules(v string) *GossValidateRequester

+ func (d *GossValidateRequester) YamlVars(v string) *GossValidateRequester

v0.26.1

Aug 3, 2022

v0.26.0

Jun 23, 2022

Changes in this version

type ChecksResult

+ func (d *ChecksResult) AllOutputs() []*ChecksOutput

type GossValidateResult

+ func (d *GossValidateResult) AllOutputs() []*GossValidateOutput

type MaintenanceResult

+ func (d *MaintenanceResult) AllOutputs() []*MaintenanceOutput

type ResumeResult

+ func (d *ResumeResult) AllOutputs() []*ResumeOutput

type TriggerResult

+ func (d *TriggerResult) AllOutputs() []*TriggerOutput

v0.25.1

Feb 25, 2022

v0.25.0

Feb 23, 2022

v0.24.1

Sep 21, 2021

v0.24.0

Sep 21, 2021

v0.23.0

Aug 24, 2021

Changes in this version

type InitializationOption

+ func Choria(fw ChoriaFramework) InitializationOption

type ScoutClient

+ func (p *ScoutClient) OptionReplyTo(t string) *ScoutClient

type Stats

+ UniqueRequestID func() string

v0.22.0

Apr 22, 2021

v0.21.0

Mar 29, 2021

v0.20.2

Feb 3, 2021

v0.20.1

Feb 3, 2021

v0.20.0

Feb 3, 2021

Changes in this version

type ChoriaFramework

+ ProgressWidth func() int

+ type ExternalNS struct

+ func (p *ExternalNS) Discover(ctx context.Context, fw ChoriaFramework, filters []FilterFunc) ([]string, error)

+ func (p *ExternalNS) Reset()

+ type MetaNS struct

+ Agent string

+ DisablePipedDiscovery bool

+ Options *discovery.StandardOptions

+ func NewMetaNS(opts *discovery.StandardOptions, enablePipeMode bool) *MetaNS

+ func (p *MetaNS) Discover(ctx context.Context, fw ChoriaFramework, _ []FilterFunc) ([]string, error)

+ func (p *MetaNS) Reset()

type Stats

+ OverrideDiscoveryTime func(start time.Time, end time.Time)

v0.19.0

Jan 13, 2021

Changes in this version

+ const Aborted

+ const DisplayAll

+ const DisplayDDL

+ const DisplayFailed

+ const DisplayNone

+ const DisplayOK

+ const InvalidData

+ const MissingData

+ const OK

+ const UnknownAction

+ const UnknownError

+ func DDL() (*agent.DDL, error)

+ func DDLBytes() ([]byte, error)

+ type BroadcastNS struct

+ func (b *BroadcastNS) Discover(ctx context.Context, fw ChoriaFramework, filters []FilterFunc) ([]string, error)

+ func (b *BroadcastNS) Reset()

+ type ChecksOutput struct

+ func (d *ChecksOutput) Checks() []interface{}

+ func (d *ChecksOutput) HashMap() map[string]interface{}

+ func (d *ChecksOutput) JSON() ([]byte, error)

+ func (d *ChecksOutput) ParseChecksOutput(target interface{}) error

+ func (d *ChecksOutput) ResultDetails() *ResultDetails

+ type ChecksRequester struct

+ func (d *ChecksRequester) Do(ctx context.Context) (*ChecksResult, error)

+ type ChecksResult struct

+ func (d *ChecksResult) EachOutput(h func(r *ChecksOutput))

+ func (d *ChecksResult) RenderResults(w io.Writer, format RenderFormat, displayMode DisplayMode, verbose bool, ...) error

+ func (d *ChecksResult) Stats() Stats

+ type ChoriaFramework interface

+ Certname func() string

+ Colorize func(c string, format string, a ...interface{}) string

+ Configuration func() *config.Config

+ Logger func(string) *logrus.Entry

+ MiddlewareServers func() (servers srvcache.Servers, err error)

+ NewConnector func(ctx context.Context, servers func() (srvcache.Servers, error), name string, ...) (conn choria.Connector, err error)

+ NewMessage func(payload string, agent string, collective string, msgType string, ...) (msg *choria.Message, err error)

+ NewReplyFromTransportJSON func(payload []byte, skipvalidate bool) (msg protocol.Reply, err error)

+ NewRequestID func() (string, error)

+ NewTransportFromJSON func(data string) (message protocol.TransportMessage, err error)

+ PQLQueryCertNames func(query string) ([]string, error)

+ SetLogger func(*logrus.Logger)

+ type DisplayMode uint8

+ type FilterFunc func(f *protocol.Filter) error

+ type GossValidateOutput struct

+ func (d *GossValidateOutput) Failures() int64

+ func (d *GossValidateOutput) HashMap() map[string]interface{}

+ func (d *GossValidateOutput) JSON() ([]byte, error)

+ func (d *GossValidateOutput) ParseGossValidateOutput(target interface{}) error

+ func (d *GossValidateOutput) ResultDetails() *ResultDetails

+ func (d *GossValidateOutput) Results() []interface{}

+ func (d *GossValidateOutput) Runtime() int64

+ func (d *GossValidateOutput) Success() string

+ func (d *GossValidateOutput) Summary() string

+ func (d *GossValidateOutput) Tests() int64

+ type GossValidateRequester struct

+ func (d *GossValidateRequester) Do(ctx context.Context) (*GossValidateResult, error)

+ func (d *GossValidateRequester) Vars(v string) *GossValidateRequester

+ type GossValidateResult struct

+ func (d *GossValidateResult) EachOutput(h func(r *GossValidateOutput))

+ func (d *GossValidateResult) RenderResults(w io.Writer, format RenderFormat, displayMode DisplayMode, verbose bool, ...) error

+ func (d *GossValidateResult) Stats() Stats

+ type InitializationOption func(opts *initOptions)

+ func ConfigFile(f string) InitializationOption

+ func Discovery(ns NodeSource) InitializationOption

+ func DiscoveryMethod(m string) InitializationOption

+ func DiscoveryTimeout(t time.Duration) InitializationOption

+ func Logger(l *logrus.Entry) InitializationOption

+ func Progress() InitializationOption

+ type Log interface

+ Debugf func(format string, args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Infof func(format string, args ...interface{})

+ Panicf func(format string, args ...interface{})

+ Warnf func(format string, args ...interface{})

+ type MaintenanceOutput struct

+ func (d *MaintenanceOutput) Failed() []interface{}

+ func (d *MaintenanceOutput) HashMap() map[string]interface{}

+ func (d *MaintenanceOutput) JSON() ([]byte, error)

+ func (d *MaintenanceOutput) ParseMaintenanceOutput(target interface{}) error

+ func (d *MaintenanceOutput) ResultDetails() *ResultDetails

+ func (d *MaintenanceOutput) Skipped() []interface{}

+ func (d *MaintenanceOutput) Transitioned() []interface{}

+ type MaintenanceRequester struct

+ func (d *MaintenanceRequester) Checks(v []interface{}) *MaintenanceRequester

+ func (d *MaintenanceRequester) Do(ctx context.Context) (*MaintenanceResult, error)

+ type MaintenanceResult struct

+ func (d *MaintenanceResult) EachOutput(h func(r *MaintenanceOutput))

+ func (d *MaintenanceResult) RenderResults(w io.Writer, format RenderFormat, displayMode DisplayMode, verbose bool, ...) error

+ func (d *MaintenanceResult) Stats() Stats

+ type Metadata struct

+ Author string

+ Description string

+ License string

+ Name string

+ Timeout int

+ URL string

+ Version string

+ type NodeSource interface

+ Discover func(ctx context.Context, fw ChoriaFramework, filters []FilterFunc) ([]string, error)

+ Reset func()

+ type PuppetDBNS struct

+ func (p *PuppetDBNS) Discover(ctx context.Context, fw ChoriaFramework, filters []FilterFunc) ([]string, error)

+ func (p *PuppetDBNS) Reset()

+ type RenderFormat int

+ const JSONFormat

+ const TXTFooter

+ const TableFormat

+ const TextFormat

+ type ResultDetails struct

+ func (d *ResultDetails) OK() bool

+ func (d *ResultDetails) Sender() string

+ func (d *ResultDetails) StatusCode() StatusCode

+ func (d *ResultDetails) StatusMessage() string

+ type ResumeOutput struct

+ func (d *ResumeOutput) Failed() []interface{}

+ func (d *ResumeOutput) HashMap() map[string]interface{}

+ func (d *ResumeOutput) JSON() ([]byte, error)

+ func (d *ResumeOutput) ParseResumeOutput(target interface{}) error

+ func (d *ResumeOutput) ResultDetails() *ResultDetails

+ func (d *ResumeOutput) Skipped() []interface{}

+ func (d *ResumeOutput) Transitioned() []interface{}

+ type ResumeRequester struct

+ func (d *ResumeRequester) Checks(v []interface{}) *ResumeRequester

+ func (d *ResumeRequester) Do(ctx context.Context) (*ResumeResult, error)

+ type ResumeResult struct

+ func (d *ResumeResult) EachOutput(h func(r *ResumeOutput))

+ func (d *ResumeResult) RenderResults(w io.Writer, format RenderFormat, displayMode DisplayMode, verbose bool, ...) error

+ func (d *ResumeResult) Stats() Stats

+ type ScoutClient struct

+ func Must(opts ...InitializationOption) (client *ScoutClient)

+ func New(opts ...InitializationOption) (client *ScoutClient, err error)

+ func (p *ScoutClient) AgentMetadata() *Metadata

+ func (p *ScoutClient) Checks() *ChecksRequester

+ func (p *ScoutClient) DiscoverNodes(ctx context.Context) (nodes []string, err error)

+ func (p *ScoutClient) GossValidate(fileI string) *GossValidateRequester

+ func (p *ScoutClient) Maintenance() *MaintenanceRequester

+ func (p *ScoutClient) OptionAgentFilter(a ...string) *ScoutClient

+ func (p *ScoutClient) OptionClassFilter(f ...string) *ScoutClient

+ func (p *ScoutClient) OptionCollective(c string) *ScoutClient

+ func (p *ScoutClient) OptionCombinedFilter(f ...string) *ScoutClient

+ func (p *ScoutClient) OptionCompoundFilter(f ...string) *ScoutClient

+ func (p *ScoutClient) OptionDiscoveryTimeout(t time.Duration) *ScoutClient

+ func (p *ScoutClient) OptionExprFilter(f string) *ScoutClient

+ func (p *ScoutClient) OptionFactFilter(f ...string) *ScoutClient

+ func (p *ScoutClient) OptionIdentityFilter(f ...string) *ScoutClient

+ func (p *ScoutClient) OptionInBatches(size int, sleep int) *ScoutClient

+ func (p *ScoutClient) OptionLimitMethod(m string) *ScoutClient

+ func (p *ScoutClient) OptionLimitSeed(s int64) *ScoutClient

+ func (p *ScoutClient) OptionLimitSize(s string) *ScoutClient

+ func (p *ScoutClient) OptionReset() *ScoutClient

+ func (p *ScoutClient) OptionTargets(t []string) *ScoutClient

+ func (p *ScoutClient) OptionWorkers(w int) *ScoutClient

+ func (p *ScoutClient) Resume() *ResumeRequester

+ func (p *ScoutClient) Trigger() *TriggerRequester

+ type Stats interface

+ Action func() string

+ Agent func() string

+ All func() bool

+ DiscoveredCount func() int

+ DiscoveredNodes func() *[]string

+ DiscoveryDuration func() (time.Duration, error)

+ FailCount func() int

+ NoResponseFrom func() []string

+ OKCount func() int

+ PublishDuration func() (time.Duration, error)

+ RequestDuration func() (time.Duration, error)

+ ResponsesCount func() int

+ UnexpectedResponseFrom func() []string

+ type StatusCode uint8

+ type TriggerOutput struct

+ func (d *TriggerOutput) Failed() []interface{}

+ func (d *TriggerOutput) HashMap() map[string]interface{}

+ func (d *TriggerOutput) JSON() ([]byte, error)

+ func (d *TriggerOutput) ParseTriggerOutput(target interface{}) error

+ func (d *TriggerOutput) ResultDetails() *ResultDetails

+ func (d *TriggerOutput) Skipped() []interface{}

+ func (d *TriggerOutput) Transitioned() []interface{}

+ type TriggerRequester struct

+ func (d *TriggerRequester) Checks(v []interface{}) *TriggerRequester

+ func (d *TriggerRequester) Do(ctx context.Context) (*TriggerResult, error)

+ type TriggerResult struct

+ func (d *TriggerResult) EachOutput(h func(r *TriggerOutput))

+ func (d *TriggerResult) RenderResults(w io.Writer, format RenderFormat, displayMode DisplayMode, verbose bool, ...) error

+ func (d *TriggerResult) Stats() Stats

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL