metrics

Documentation

Index

• Constants
• type Collector
• type DBCacheQuery
• type DBQuery
• type GRPCRequest
• type HTTPRequest

Constants

const (
	// StatBaseDB is the base state name for database metrics.
	StatBaseDB = "db"
	// StatDBQuery is the timing for a db query.
	StatDBQuery = StatBaseDB + ".query"
	// StatDBQueryTiming is the timing for a db query.
	StatDBQueryTiming = StatDBQuery + ".timing"
	// StatDBQueryCount is the counts for db queries.
	StatDBQueryCount = StatDBQuery + ".count"

	// StatBaseDBCache is the base state name for database cache metrics.
	StatBaseDBCache = "dbcache"
	// StatDBCacheQuery is the timing for a db query.
	StatDBCacheQuery = StatBaseDBCache + ".query"
	// StatDBCacheQueryTiming is the timing for a db query.
	StatDBCacheQueryTiming = StatDBCacheQuery + ".timing"
	// StatDBCacheQueryCount is the counts for db queries.
	StatDBCacheQueryCount = StatDBCacheQuery + ".count"

	// StatBaseGRPC is the base state name for grpc metrics.
	StatBaseGRPC = "grpc"
	// StatGRPCRequest is the timing for a grpc request.
	StatGRPCRequest = StatBaseGRPC + ".request"
	// StatGRPCRequestTiming is the timing for a grpc request.
	StatGRPCRequestTiming = StatGRPCRequest + ".timing"
	// StatGRPCRequestCount is the counts for grpc requests.
	StatGRPCRequestCount = StatGRPCRequest + ".count"

	// StatBaseHTTP is the base state name for http metrics.
	StatBaseHTTP = "http"
	// StatHTTPRequest is the timing for a http request.
	StatHTTPRequest = StatBaseHTTP + ".request"
	// StatHTTPRequestTiming is the timing for a http request.
	StatHTTPRequestTiming = StatHTTPRequest + ".timing"
	// StatHTTPRequestCount is the counts for http requests.
	StatHTTPRequestCount = StatHTTPRequest + ".count"

	// StatBaseSys is the base state name for system metrics.
	StatBaseSys = "sys"
	// StatSysMem is the base state name for system memory metrics.
	StatSysMem = StatBaseSys + ".mem"
	// StatSysMemAlloc is the gauge for memory allocation.
	StatSysMemAlloc = StatSysMem + ".alloc"
	// StatSysMemAllocTotal is the gauge for memory total allocation.
	StatSysMemAllocTotal = StatSysMem + ".alloc-total"
	// StatSysMemSys is the gauge for system memory usage.
	StatSysMemSys = StatSysMem + ".sys"
	// StatSysMemNumGC is the counter for.
	StatSysMemNumGC = StatSysMem + ".num-gc"
	// StatSysRoutines is the gauge for the number of active go routines.
	StatSysRoutines = StatBaseSys + ".goroutines"

	// TagCode is an code tag.
	TagCode = "code"
	// TagError is an error tag.
	TagError = "error"
	// TagHit is a hit tag (caching).
	TagHit = "hit"
	// TagMethod is a method tag.
	TagMethod = "method"
	// TagName is a name tag.
	TagName = "name"
	// TagPath is a path tag.
	TagPath = "path"
	// TagStatus is a status tag.
	TagStatus = "status"
)

Types

type Collector

type Collector interface {
	Close() error

	NewDBQuery(name string) DBQuery
	NewDBCacheQuery(name string) DBCacheQuery
	NewGRPCRequest(method string) GRPCRequest
	NewHTTPRequest(method, path string) HTTPRequest
}

Collector collects metrics from the feditools.

type DBCacheQuery

type DBCacheQuery interface {
	Done(hit bool, isError bool) time.Duration
}

DBCacheQuery is a new database cache query metric measurer.

type DBQuery

type DBQuery interface {
	Done(isError bool) time.Duration
}

DBQuery is a new database query metric measurer.

type GRPCRequest

type GRPCRequest interface {
	Done(code int) time.Duration
}

GRPCRequest is a new grpc request metric measurer.

type HTTPRequest

type HTTPRequest interface {
	Done(status int) time.Duration
}

HTTPRequest is a new http request metric measurer.