config

Documentation

Index

• Constants
• func GetMetricsConfigName() string
• func GetRetentionPolicyConfigName() string
• func ToContext(ctx context.Context, c *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) *Config
• type Metrics
  • func NewMetricsFromConfigMap(config *corev1.ConfigMap) (*Metrics, error)
  • func (cfg *Metrics) DeepCopy() *Metrics
  • func (cfg *Metrics) Equals(other *Metrics) bool
• type RetentionPolicy
  • func NewRetentionPolicyFromConfigMap(config *corev1.ConfigMap) (*RetentionPolicy, error)
  • func (cfg *RetentionPolicy) DeepCopy() *RetentionPolicy
  • func (cfg *RetentionPolicy) Equals(other *RetentionPolicy) bool
• type Store
  • func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value any)) *Store
  • func (s *Store) Load() *Config
  • func (s *Store) ToContext(ctx context.Context) context.Context

Constants

const (

	// DefaultTaskrunLevel determines to what level to aggregate metrics
	// when it isn't specified in configmap
	DefaultTaskrunLevel = TaskrunLevelAtTask
	// TaskrunLevelAtTask specify that aggregation will be done at task level
	TaskrunLevelAtTask = "task"
	// TaskrunLevelAtNS specify that aggregation will be done at namespace level
	TaskrunLevelAtNS = "namespace"
	// DefaultPipelinerunLevel determines to what level to aggregate metrics
	// when it isn't specified in configmap
	DefaultPipelinerunLevel = PipelinerunLevelAtPipeline
	// PipelinerunLevelAtPipeline specify that aggregation will be done at
	// pipeline level
	PipelinerunLevelAtPipeline = "pipeline"
	// PipelinerunLevelAtNS specify that aggregation will be done at
	// namespace level
	PipelinerunLevelAtNS = "namespace"

	// DefaultDurationTaskrunType determines what type
	// of metrics to use when we don't specify one in
	// configmap
	DefaultDurationTaskrunType = "histogram"
	// DurationTaskrunTypeHistogram specify that histogram
	// type metrics need to be used for Duration of Taskrun
	DurationTaskrunTypeHistogram = "histogram"
	// DurationTaskrunTypeLastValue specify that lastValue or
	// gauge type metrics need to be used for Duration of Taskrun
	DurationTaskrunTypeLastValue = "lastvalue"

	// DefaultDurationPipelinerunType determines what type
	// of metrics to use when we don't specify one in
	// configmap
	DefaultDurationPipelinerunType = "histogram"
	// DurationPipelinerunTypeHistogram specify that histogram
	// type metrics need to be used for Duration of Pipelinerun
	DurationPipelinerunTypeHistogram = "histogram"
	// DurationPipelinerunTypeLastValue specify that lastValue or
	// gauge type metrics need to be used for Duration of Pipelinerun
	DurationPipelinerunTypeLastValue = "lastvalue"
)

const (

	// DefaultRunAt is the default value for RunAt
	DefaultRunAt = "7 7 * * 7"
	// DefaultMaxRetention is the default value for MaxRetention
	DefaultMaxRetention = time.Hour * 24 * 30
)

Functions

func GetMetricsConfigName

func GetMetricsConfigName() string

GetMetricsConfigName returns the name of the configmap containing all customizations for the storage bucket.

func GetRetentionPolicyConfigName

func GetRetentionPolicyConfigName() string

GetRetentionPolicyConfigName returns the name of the configmap containing retention policy.

func ToContext

func ToContext(ctx context.Context, c *Config) context.Context

ToContext attaches the provided Config to the provided context, returning the new context with the Config attached.

Types

type Config

type Config struct {
	Metrics *Metrics
}

Config holds the collection of configurations that we attach to contexts.

func FromContext

func FromContext(ctx context.Context) *Config

FromContext extracts a Config from the provided context.

type Metrics

type Metrics struct {
	TaskrunLevel            string
	PipelinerunLevel        string
	DurationTaskrunType     string
	DurationPipelinerunType string
}

Metrics holds the configurations for the metrics

func NewMetricsFromConfigMap

func NewMetricsFromConfigMap(config *corev1.ConfigMap) (*Metrics, error)

NewMetricsFromConfigMap returns a Config for the given configmap

func (*Metrics) DeepCopy

func (cfg *Metrics) DeepCopy() *Metrics

DeepCopy copying the receiver, creating a new Metrics. deepcopy-gen hasn't been introduced in results repo, so handcraft here for now

func (*Metrics) Equals

func (cfg *Metrics) Equals(other *Metrics) bool

Equals returns true if two Configs are identical

type RetentionPolicy

type RetentionPolicy struct {
	RunAt        string
	MaxRetention time.Duration
}

RetentionPolicy holds the configurations for the Retention Policy of the DB

func NewRetentionPolicyFromConfigMap

func NewRetentionPolicyFromConfigMap(config *corev1.ConfigMap) (*RetentionPolicy, error)

NewRetentionPolicyFromConfigMap returns a Config for the given configmap

func (*RetentionPolicy) DeepCopy

func (cfg *RetentionPolicy) DeepCopy() *RetentionPolicy

DeepCopy copying the receiver, creating a new RetentionPolicy. deepcopy-gen hasn't been introduced in results repo, so handcraft here for now

func (*RetentionPolicy) Equals

func (cfg *RetentionPolicy) Equals(other *RetentionPolicy) bool

Equals returns true if two Configs are identical

type Store

type Store struct {
	*configmap.UntypedStore
}

Store is a typed wrapper around configmap.Untyped store to handle our configmaps.

func NewStore

func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value any)) *Store

NewStore creates a new store of Configs and optionally calls functions when ConfigMaps are updated.

func (*Store) Load

func (s *Store) Load() *Config

Load creates a Config from the current config state of the Store.

func (*Store) ToContext

func (s *Store) ToContext(ctx context.Context) context.Context

ToContext attaches the current Config state to the provided context.