telemetry

Documentation

Index

• Variables
• func Initialize(telemetryDisabled bool, stepName string)
• func Send(customData *CustomData)
• type BaseData
• type BaseMetaData
• type CustomData
• type Data
  • func GetData(customData *CustomData) Data

Variables

var LibraryRepository string

LibraryRepository that is passed into with -ldflags

var SiteID string

SiteID ...

Functions

func Initialize

func Initialize(telemetryDisabled bool, stepName string)

Initialize sets up the base telemetry data and is called in generated part of the steps

func Send

func Send(customData *CustomData)

Send ...

Types

type BaseData

type BaseData struct {
	// SWA receives the fields custom1 - custom30 and e_a, e_2 - e_30 for custom values.
	ActionName      string `json:"action_name"`
	EventType       string `json:"event_type"`
	SiteID          string `json:"idsite"`
	URL             string `json:"url"`
	StepName        string `json:"e_3"` // set by step generator
	StageName       string `json:"e_10"`
	PipelineURLHash string `json:"e_4"` // defaults to sha1 of env.JOB_URl
	BuildURLHash    string `json:"e_5"` // defaults to sha1 of env.BUILD_URL
}

BaseData object definition containing the base data and it's mapping information

type BaseMetaData

type BaseMetaData struct {
	// SWA receives the fields custom1 - custom30 and e_a, e_2 - e_30 for custom values.
	StepNameLabel        string `json:"custom3"`
	StageNameLabel       string `json:"custom10"`
	PipelineURLHashLabel string `json:"custom4"`
	BuildURLHashLabel    string `json:"custom5"`
	DurationLabel        string `json:"custom11,omitempty"`
	ExitCodeLabel        string `json:"custom12,omitempty"`
	ErrorCategoryLabel   string `json:"custom13,omitempty"`
}

BaseMetaData object definition containing the labels for the base data and it's mapping information

type CustomData

type CustomData struct {
	// SWA receives the fields custom1 - custom30 and e_a, e_2 - e_30 for custom values.
	// Piper uses the values custom11 - custom25 & e_11 - e_25 for library related reporting
	// and custom26 - custom30 & e_26 - e_30 for step  related reporting.
	Duration      string `json:"e_11,omitempty"`
	ErrorCode     string `json:"e_12,omitempty"`
	ErrorCategory string `json:"e_13,omitempty"`
	Custom1Label  string `json:"custom26,omitempty"`
	Custom2Label  string `json:"custom27,omitempty"`
	Custom3Label  string `json:"custom28,omitempty"`
	Custom4Label  string `json:"custom29,omitempty"`
	Custom5Label  string `json:"custom30,omitempty"`
	Custom1       string `json:"e_26,omitempty"`
	Custom2       string `json:"e_27,omitempty"`
	Custom3       string `json:"e_28,omitempty"`
	Custom4       string `json:"e_29,omitempty"`
	Custom5       string `json:"e_30,omitempty"`
}

CustomData object definition containing the data that can be set by a step and it's mapping information

type Data

type Data struct {
	BaseData
	BaseMetaData
	CustomData
}

Data object definition containing all telemetry data

func GetData

func GetData(customData *CustomData) Data