flare

Documentation

Overview

Package flare implements a component to generate flares from the agent.

A flare is a archive containing all the information necessary to troubleshoot the Agent. When openeing a support ticket a flare might be requested. Flares contain the Agent logs, configurations and much more.

Index

• func Module(params Params) fxutil.Module
• type Component
• type Params
  • func NewLocalParams(distPath string, pythonChecksPath string, defaultLogFile string, ...) Params
  • func NewParams(distPath string, pythonChecksPath string, defaultLogFile string, ...) Params
• type ProfileData

Functions

func Module

func Module(params Params) fxutil.Module

Module defines the fx options for this component.

Types

type Component

type Component interface {
	// Create creates a new flare locally and returns the path to the flare file.
	//
	// If providerTimeout is 0 or negative, the timeout from the configuration will be used.
	Create(pdata ProfileData, providerTimeout time.Duration, ipcError error) (string, error)
	// Send sends a flare archive to Datadog.
	Send(flarePath string, caseID string, email string, source helpers.FlareSource) (string, error)
}

Component is the component type.

type Params

type Params struct {
	// contains filtered or unexported fields
}

Params defines the parameters for the flare component.

func NewLocalParams

func NewLocalParams(distPath string, pythonChecksPath string, defaultLogFile string, defaultJMXLogFile string, defaultDogstatsdLogFile string, defaultStreamlogsLogFile string) Params

NewLocalParams returns parameters for to initialize a local flare component. Local flares are meant to be created by the CLI process instead of the main Agent one.

func NewParams

func NewParams(distPath string, pythonChecksPath string, defaultLogFile string, defaultJMXLogFile string, defaultDogstatsdLogFile string, defaultStreamlogsLogFile string) Params

NewParams returns parameters for to initialize a non local flare component

type ProfileData

type ProfileData map[string][]byte

ProfileData maps (pprof) profile names to the profile data.