accounting

Documentation

Overview

Package accounting provides information about the number of active series produed by checks and other related metrics.

Code generated automatically. DO NOT EDIT.

Index

• Variables
• func GetAccountingClassInfo() map[string]ClassInfo
• func GetActiveSeriesForCheck(check synthetic_monitoring.Check) (int, error)
• func GetCheckAccountingClass(check synthetic_monitoring.Check) (string, error)
• type ClassInfo

Variables

var ErrUnhandledCheck = errors.New("cannot compute the number of active series for check")

Functions

func GetAccountingClassInfo

func GetAccountingClassInfo() map[string]ClassInfo

GetAccountingClassInfo returns all the known accounting classes and their corresponding information

func GetActiveSeriesForCheck

func GetActiveSeriesForCheck(check synthetic_monitoring.Check) (int, error)

GetActiveSeriesForCheck returns the number of active series that the provided check produces. The data is embedded in the program at build time and it's obtained from the test data used to keep the generated series in sync with the rest of the program.

This is of course dependent on the running agent being the same version as the code embedded in the program using this information.

func GetCheckAccountingClass

func GetCheckAccountingClass(check synthetic_monitoring.Check) (string, error)

GetCheckAccountingClass returns the accounting class corresponding to the specified check.

Types

type ClassInfo

type ClassInfo struct {
	CheckType  synthetic_monitoring.CheckType  // the correspodning check type for this class
	CheckClass synthetic_monitoring.CheckClass // the check class for this accounting class
	Series     int                             // how many series does this class of check produce
}

ClassInfo contains information about a specific accounting class