stats

Documentation

Overview

Package stats defines opencensus monitoring stats exposed by Scorecard.

Index

• Variables

Variables

var (
	// CheckRuntimeInSec measures the CPU runtime in seconds per check.
	CheckRuntimeInSec = stats.Int64("CheckRuntimeInSec", "Measures the CPU runtime in seconds for a check",
		stats.UnitSeconds)
	// CheckErrors measures the count of errors per check.
	CheckErrors = stats.Int64("CheckErrors", "Measures the count of errors", stats.UnitDimensionless)
	// HTTPRequests measures the count of HTTP requests.
	HTTPRequests = stats.Int64("HTTPRequests", "Measures the count of HTTP requests", stats.UnitDimensionless)
)

var (
	// CheckName is the tag key for the check name.
	CheckName = tag.MustNewKey("checkName")
	// ErrorName is the tag key for errors.
	ErrorName = tag.MustNewKey("errorName")
	// RequestTag is the tag key for the request type.
	RequestTag = tag.MustNewKey("requestTag")
	// RepoHost is the tag key for the host of the repository being scanned.
	RepoHost = tag.MustNewKey("repoHost")
)

var (
	// CheckRuntime tracks CPU runtime stats for checks.
	CheckRuntime = view.View{
		Name:        "CheckRuntime",
		Description: "CPU runtime stats per check",
		Measure:     CheckRuntimeInSec,
		TagKeys:     []tag.Key{CheckName, RepoHost},

		Aggregation: view.Distribution(
			0,
			1<<2,
			1<<3,
			1<<4,
			1<<5,
			1<<6,
			1<<7,
			1<<8,
			1<<9,
			1<<10,
			1<<11,
			1<<12,
			1<<13,
			1<<14,
			1<<15),
	}

	// CheckErrorCount tracks error count stats for checks.
	CheckErrorCount = view.View{
		Name:        "CheckErrorCount",
		Description: "Error count by type per check",
		Measure:     CheckErrors,
		TagKeys:     []tag.Key{CheckName, RepoHost, ErrorName},
		Aggregation: view.Count(),
	}

	// OutgoingHTTPRequests tracks HTTPRequests made.
	OutgoingHTTPRequests = view.View{
		Name:        "OutgoingHTTPRequests",
		Description: "HTTPRequests made per check",
		Measure:     HTTPRequests,
		TagKeys:     []tag.Key{CheckName, RepoHost, RequestTag},
		Aggregation: view.Count(),
	}
)