flare

Documentation

Overview

Package flare contains the logic to create a flare archive.

Index

• Variables
• func CreateDCAArchive(local bool, distPath, logFilePath string, pdata ProfileData, ...) (string, error)
• func CreateSecurityAgentArchive(local bool, logFilePath string, statusComponent status.Component) (string, error)
• func ExtraFlareProviders(diagnoseDeps diagnose.SuitesDeps) []*flaretypes.FlareFiller
• func GetClusterAgentConfigCheck(w io.Writer, withDebug bool) error
• func GetClusterAgentDiagnose(w io.Writer) error
• func GetClusterChecks(w io.Writer, checkName string) error
• func GetEndpointsChecks(w io.Writer, checkName string) 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 QueryDCAMetrics() ([]byte, error)
• func SendFlare(cfg pkgconfigmodel.Reader, archivePath string, caseID string, email string, ...) (string, error)
• type ProfileData

Variables

var (
	// ErrNotCompiled is returned if kubernetes apiserver support is not compiled in.
	// User classes should handle that case as gracefully as possible.
	ErrNotCompiled = errors.New("kubernetes apiserver support not compiled in")
)

Functions

func CreateDCAArchive

func CreateDCAArchive(local bool, distPath, logFilePath string, pdata ProfileData, statusComponent status.Component) (string, error)

CreateDCAArchive packages up the files

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 GetClusterAgentConfigCheck

func GetClusterAgentConfigCheck(w io.Writer, withDebug bool) error

GetClusterAgentConfigCheck gets config check from the server for cluster agent

func GetClusterAgentDiagnose

func GetClusterAgentDiagnose(w io.Writer) error

GetClusterAgentDiagnose dumps the connectivity checks diagnose to the writer

func GetClusterChecks

func GetClusterChecks(w io.Writer, checkName string) error

GetClusterChecks dumps the clustercheck dispatching state to the writer

func GetEndpointsChecks

func GetEndpointsChecks(w io.Writer, checkName string) error

GetEndpointsChecks dumps the endpointschecks dispatching state to the writer

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 QueryDCAMetrics

func QueryDCAMetrics() ([]byte, error)

QueryDCAMetrics gets the metrics payload exposed by the cluster agent

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.

Types

type ProfileData

type ProfileData map[string][]byte

ProfileData maps (pprof) profile names to the profile data