flare

Documentation

Overview

Package flare contains the logic to create a flare archive.

Index

• func CreateSecurityAgentArchive(local bool, logFilePath string, statusComponent status.Component) (string, error)
• func ExtraFlareProviders(diagnoseDeps diagnose.SuitesDeps) []*flaretypes.FlareFiller
• func GetConfigFiles(fb flaretypes.FlareBuilder, confSearchPaths map[string]string)
• func GetEnvVars() ([]byte, error)
• func GetExpVar(fb flaretypes.FlareBuilder) error
• func GetLogFiles(fb flaretypes.FlareBuilder, logFileDir string)
• func GetTaggerList(remoteURL string) ([]byte, error)
• func GetWorkloadList(url string) ([]byte, error)
• func PrintConfig(w io.Writer, c integration.Config, checkName string)
• func PrintConfigCheck(w io.Writer, cr integration.ConfigCheckResponse, withDebug bool)
• func PrintRemoteConfigStates(w io.Writer, state *pbgo.GetStateConfigResponse, ...)
• func SendFlare(cfg pkgconfigmodel.Reader, archivePath string, caseID string, email string, ...) (string, error)

Functions

func CreateSecurityAgentArchive

func CreateSecurityAgentArchive(local bool, logFilePath string, statusComponent status.Component) (string, error)

CreateSecurityAgentArchive packages up the files

func ExtraFlareProviders

func ExtraFlareProviders(diagnoseDeps diagnose.SuitesDeps) []*flaretypes.FlareFiller

ExtraFlareProviders returns flare providers that are not given via fx. This function should only be called by the flare component.

func GetConfigFiles

func GetConfigFiles(fb flaretypes.FlareBuilder, confSearchPaths map[string]string)

GetConfigFiles copies configuration files to the flare archive.

func GetEnvVars

func GetEnvVars() ([]byte, error)

GetEnvVars collects allowed envvars that can affect the agent's behaviour while not being handled by viper, in addition to the envvars handled by viper

func GetExpVar

func GetExpVar(fb flaretypes.FlareBuilder) error

GetExpVar copies expvar files to the flare archive.

func GetLogFiles

func GetLogFiles(fb flaretypes.FlareBuilder, logFileDir string)

GetLogFiles copies log files to the flare archive.

func GetTaggerList

func GetTaggerList(remoteURL string) ([]byte, error)

GetTaggerList fetches the tagger list from the given URL.

func GetWorkloadList

func GetWorkloadList(url string) ([]byte, error)

GetWorkloadList fetches the workload list from the given URL.

func PrintConfig

func PrintConfig(w io.Writer, c integration.Config, checkName string)

PrintConfig prints a human-readable representation of a configuration with any secrets scrubbed.

func PrintConfigCheck

func PrintConfigCheck(w io.Writer, cr integration.ConfigCheckResponse, withDebug bool)

PrintConfigCheck prints a human-readable representation of the config check response

func PrintRemoteConfigStates

func PrintRemoteConfigStates(w io.Writer, state *pbgo.GetStateConfigResponse, stateHA *pbgo.GetStateConfigResponse)

PrintRemoteConfigStates dump the whole remote-config state

func SendFlare

func SendFlare(cfg pkgconfigmodel.Reader, archivePath string, caseID string, email string, source helpers.FlareSource) (string, error)

SendFlare sends a flare and returns the message returned by the backend. This entry point is deprecated in favor of the 'Send' method of the flare component.