metrics

Documentation

Index

• Variables
• type Client
  • func NewClient() (*Client, error)
  • func (c *Client) GetMetrics(args *GetMetricsArgs) (*Dataset, error)
  • func (c *Client) InsertRecord(args *InsertRecordArgs) error
• type Dataset
• type GetMetricsArgs
• type InsertRecordArgs
• type InvokerEnum
• type NextEnum
• type StateData

Variables

var InvokerEnumLabels = map[InvokerEnum]string{
	InvokerUnknown: "unknown",
}

InvokerEnumLabels an array of all the InvokerEnum

var NextEnums = []NextEnum{
	NextEnd, NextTransition, NextRetry,
}

NextEnums an array of all the NextEnum

Types

type Client

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

Client ..

func NewClient

func NewClient() (*Client, error)

NewClient ..

func (*Client) GetMetrics

func (c *Client) GetMetrics(args *GetMetricsArgs) (*Dataset, error)

GetMetrics returns the metrics from the database

func (*Client) InsertRecord

func (c *Client) InsertRecord(args *InsertRecordArgs) error

InsertRecord inserts a metric record into the database

type Dataset

type Dataset struct {
	TotalInstancesRun         int32 `json:"totalInstancesRun"`
	TotalInstanceMilliSeconds int32 `json:"totalInstanceMilliseconds"`
	SuccessfulExecutions      int32 `json:"successfulExecutions"`
	FailedExecutions          int32 `json:"failedExecutions"`

	ErrorCodes               map[string]int32   `json:"errorCodes"`
	ErrorCodesRepresentation map[string]float32 `json:"errorCodesRepresentation"`

	SampleSize               int32   `json:"sampleSize"`
	MeanInstanceMilliSeconds int32   `json:"avgInstanceMilliseconds"`
	SuccessRate              float32 `json:"successRate"`
	FailureRate              float32 `json:"failureRate"`

	States []StateData `json:"states" toml:"states"`
}

Dataset ..

type GetMetricsArgs

type GetMetricsArgs struct {
	Namespace string
	Workflow  string
	Since     time.Time
}

GetMetricsArgs ..

type InsertRecordArgs

type InsertRecordArgs struct {
	Namespace            string
	Workflow             string
	Instance             string
	State                string
	WorkflowMilliSeconds int64
	IsolateMilliSeconds  int64
	ErrorCode            string
	Invoker              string
	Next                 NextEnum
	Transition           string
}

InsertRecordArgs ..

type InvokerEnum

type InvokerEnum int

InvokerEnum the enum for what invoked the workflow

const (
	// InvokerUnknown if the invoker is unknown
	InvokerUnknown InvokerEnum = iota
)

type NextEnum

type NextEnum int

NextEnum could be the state ended, transitioned or retried

const (
	// NextEnd the state has ended
	NextEnd NextEnum = iota // State has ended
	// NextTransition the state has transitioned
	NextTransition // State transitioned
	// NextRetry the state has retried
	NextRetry // State retried
)

type StateData

type StateData struct {
	Name string `json:"name"`

	Invokers               map[string]int32 `json:"invokers"`
	InvokersRepresentation map[string]float32

	TotalExecutions   int32 `json:"totalExecutions"`
	TotalMilliSeconds int32 `json:"totalMilliseconds"`
	TotalSuccesses    int32 `json:"totalSuccesses"`
	TotalFailures     int32 `json:"totalFailures"`

	UnhandledErrors               map[string]int32   `json:"unhandledErrors"`
	UnhandledErrorsRepresentation map[string]float32 `json:"unhandledErrorsRepresentation"`

	TotalRetries int32 `json:"totalRetries"`
	Outcomes     struct {
		EndStates struct {
			Success int32 `json:"success"`
			Failure int32 `json:"failure"`
		} `json:"endStates"`
		Transitions map[string]int32 `json:"transitions"`
	} `json:"outcomes"`

	MeanExecutionsPerInstance   int32   `json:"avgExecutionsPerInstance"`
	MeanMilliSecondsPerInstance int32   `json:"avgSecondsPerInstance"`
	SuccessRate                 float32 `json:"successRate"`
	FailureRate                 float32 `json:"failureRate"`

	MeanRetries  float32 `json:"avgRetries"`
	MeanOutcomes struct {
		EndStates struct {
			Success float32 `json:"success"`
			Failure float32 `json:"failure"`
		} `json:"endStates"`
		Transitions map[string]float32 `json:"transitions"`
	} `json:"avgOutcomes"`
	// contains filtered or unexported fields
}

StateData ..