helpers

Documentation

Overview

Package helpers contains helpers for the flare component.

Index

• func GetFlareEndpoint(cfg config.Reader) string
• func NewFlareBuilder(localFlare bool, flareArgs types.FlareArgs) (types.FlareBuilder, error)
• func SendTo(cfg pkgconfigmodel.Reader, archivePath, caseID, email, apiKey, url string, ...) (string, error)
• type FlareSource
  • func NewLocalFlareSource() FlareSource
  • func NewRemoteConfigFlareSource(rcTaskUUID string) FlareSource

Functions

func GetFlareEndpoint

func GetFlareEndpoint(cfg config.Reader) string

GetFlareEndpoint creates the flare endpoint URL

func NewFlareBuilder

func NewFlareBuilder(localFlare bool, flareArgs types.FlareArgs) (types.FlareBuilder, error)

NewFlareBuilder returns a new FlareBuilder ready to be used. You need to call the Save method to archive all the data pushed to the flare as well as cleanup the temporary directories created. Not calling 'Save' after NewFlareBuilder will leave temporary directory on the file system.

func SendTo

func SendTo(cfg pkgconfigmodel.Reader, archivePath, caseID, email, apiKey, url string, source FlareSource) (string, error)

SendTo sends a flare file to the backend. This is part of the "helpers" package while all the code is moved to components. When possible use the "Send" method of the "flare" component instead.

Types

type FlareSource

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

FlareSource has metadata about why the flare was sent

func NewLocalFlareSource

func NewLocalFlareSource() FlareSource

NewLocalFlareSource returns a flare source struct for local flares

func NewRemoteConfigFlareSource

func NewRemoteConfigFlareSource(rcTaskUUID string) FlareSource

NewRemoteConfigFlareSource returns a flare source struct for remote-config