telemetry

Documentation

Overview

Package telemetry holds telemetry related files

Index

• Constants
• Variables

Constants

const (
	// Subsystem is the subsystem name for the provided telemetry for sbom
	Subsystem = "sbom"
)

Variables

var (
	// SBOMAttempts tracks sbom collection attempts.
	SBOMAttempts = telemetry.NewCounterWithOpts(
		Subsystem,
		"attempts",
		[]string{"source", "type"},
		"Number of sbom failures by (source, type)",
		commonOpts,
	)
	// SBOMFailures tracks sbom collection attempts that fail.
	SBOMFailures = telemetry.NewCounterWithOpts(
		Subsystem,
		"errors",
		[]string{"source", "type", "reason"},
		"Number of sbom failures by (source, type, reason)",
		commonOpts,
	)

	// SBOMGenerationDuration measures the time that it takes to generate SBOMs
	// in seconds.
	SBOMGenerationDuration = telemetry.NewHistogramWithOpts(
		Subsystem,
		"generation_duration",
		[]string{"source", "scan_type"},
		"SBOM generation duration (in seconds)",
		[]float64{10, 30, 60, 120, 180, 240, 300, 360, 420, 480, 540, 600},
		commonOpts,
	)

	// SBOMExportSize is the size of the archive written on disk
	SBOMExportSize = telemetry.NewHistogramWithOpts(
		Subsystem,
		"export_size",
		[]string{"source", "scan_ref"},
		"Size of the archive written on disk",
		[]float64{10_000_000, 50_000_000, 100_000_000, 200_000_000, 400_000_000, 600_000_000, 800_000_000, 1_000_000_000, 1_500_000_000},
		commonOpts,
	)

	// SBOMCacheDiskSize size in disk of the custom cache used for SBOM collection
	SBOMCacheDiskSize = telemetry.NewGaugeWithOpts(
		Subsystem,
		"cache_disk_size",
		[]string{},
		"SBOM size in disk of the custom cache (in bytes)",
		commonOpts,
	)

	// SBOMCacheHits number of cache hits during SBOM collection
	SBOMCacheHits = telemetry.NewCounterWithOpts(
		Subsystem,
		"cache_hits_total",
		[]string{},
		"SBOM total number of cache hits during SBOM collection",
		commonOpts,
	)

	// SBOMCacheMisses number of cache misses during SBOM collection
	SBOMCacheMisses = telemetry.NewCounterWithOpts(
		Subsystem,
		"cache_misses_total",
		[]string{},
		"SBOM total number of cache misses during SBOM collection",
		commonOpts,
	)

	// QueueMetricsProvider is the metrics provider for the sbom scanner retry queue
	QueueMetricsProvider = workqueuetelemetry.NewQueueMetricsProvider()
)