splunk

Documentation

Index

• type Details
• type DetailsLog
• type DetailsTelemetry
• type Event
• type LogFileEvents
• type MonitoringData
• type Splunk
  • func (s *Splunk) Initialize(correlationID, dsn, token, index string, sendLogs bool) error
  • func (s *Splunk) Send(telemetryData telemetry.Data, logCollector *log.CollectorHook) error
  • func (s *Splunk) SendPipelineStatus(pipelineTelemetryData telemetry.PipelineTelemetry, logFile *[]byte) error

Types

type Details

type Details struct {
	Host       string `json:"host"`                 // hostname
	Source     string `json:"source,omitempty"`     // optional description of the source of the event; typically the app's name
	SourceType string `json:"sourcetype,omitempty"` // optional name of a Splunk parsing configuration; this is usually inferred by Splunk
	Index      string `json:"index,omitempty"`      // optional name of the Splunk index to store the event in; not required if the token has a default index set in Splunk
	Event      Event  `json:"event,omitempty"`      // throw any useful key/val pairs here}
}

type DetailsLog

type DetailsLog struct {
	Host       string        `json:"host"`                 // hostname
	Source     string        `json:"source,omitempty"`     // optional description of the source of the event; typically the app's name
	SourceType string        `json:"sourcetype,omitempty"` // optional name of a Splunk parsing configuration; this is usually inferred by Splunk
	Index      string        `json:"index,omitempty"`      // optional name of the Splunk index to store the event in; not required if the token has a default index set in Splunk
	Event      LogFileEvents `json:"event,omitempty"`      // throw any useful key/val pairs here}
}

type DetailsTelemetry

type DetailsTelemetry struct {
	Host       string                      `json:"host"`                 // hostname
	Source     string                      `json:"source,omitempty"`     // optional description of the source of the event; typically the app's name
	SourceType string                      `json:"sourcetype,omitempty"` // optional name of a Splunk parsing configuration; this is usually inferred by Splunk
	Index      string                      `json:"index,omitempty"`      // optional name of the Splunk index to store the event in; not required if the token has a default index set in Splunk
	Event      telemetry.PipelineTelemetry `json:"event,omitempty"`      // throw any useful key/val pairs here}
}

type Event

type Event struct {
	Messages  []log.Message  `json:"messages,omitempty"`  // messages
	Telemetry MonitoringData `json:"telemetry,omitempty"` // telemetryData
}

type LogFileEvents

type LogFileEvents struct {
	Messages  []string                    `json:"messages,omitempty"`  // messages
	Telemetry telemetry.PipelineTelemetry `json:"telemetry,omitempty"` // telemetryData
}

type MonitoringData

type MonitoringData struct {
	PipelineUrlHash string `json:"PipelineUrlHash,omitempty"`
	BuildUrlHash    string `json:"BuildUrlHash,omitempty"`
	StageName       string `json:"StageName,omitempty"`
	StepName        string `json:"StepName,omitempty"`
	ExitCode        string `json:"ExitCode,omitempty"`
	Duration        string `json:"Duration,omitempty"`
	ErrorCode       string `json:"ErrorCode,omitempty"`
	ErrorCategory   string `json:"ErrorCategory,omitempty"`
	CorrelationID   string `json:"CorrelationID,omitempty"`
	CommitHash      string `json:"CommitHash,omitempty"`
	Branch          string `json:"Branch,omitempty"`
	GitOwner        string `json:"GitOwner,omitempty"`
	GitRepository   string `json:"GitRepository,omitempty"`
}

MonitoringData definition for monitoring

type Splunk

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

Splunk SplunkHook provides a logrus hook which enables error logging to splunk platform. This is helpful in order to provide better monitoring and alerting on errors as well as the given error details can help to find the root cause of bugs.

func (*Splunk) Initialize

func (s *Splunk) Initialize(correlationID, dsn, token, index string, sendLogs bool) error

func (*Splunk) Send

func (s *Splunk) Send(telemetryData telemetry.Data, logCollector *log.CollectorHook) error

func (*Splunk) SendPipelineStatus

func (s *Splunk) SendPipelineStatus(pipelineTelemetryData telemetry.PipelineTelemetry, logFile *[]byte) error