cacheevent

package

v0.2.0 Latest Latest Go to latest Published: Jun 13, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sholdee/drydock

Links

Open Source Insights

Documentation ¶

Index ¶

func CompactSensitiveValues(values ...string) []string
func RedactEventError(value string, redactedTarget string, rawTargets []string, ...) string
func RedactTarget(raw string) string
type AcquisitionCollector
- func NewAcquisitionCollector() *AcquisitionCollector
- func (c *AcquisitionCollector) Record(record AcquisitionRecord)
- func (c *AcquisitionCollector) Records() []AcquisitionRecord
type AcquisitionErrorResult
- func NewAcquisitionError(input AcquisitionEventInput) AcquisitionErrorResult
type AcquisitionEventInput
type AcquisitionKind
type AcquisitionRecord
type Action
- func ActionForAcquisition(fromCache bool, network bool, refresh bool) Action
- func ActionForError(err error) Action
type Event
- func NewAcquisitionEvent(input AcquisitionEventInput) Event
type Recorder
- func NewRecorder(enabled bool) *Recorder
type Source

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CompactSensitiveValues ¶

func CompactSensitiveValues(values ...string) []string

func RedactEventError ¶

func RedactEventError(value string, redactedTarget string, rawTargets []string, sensitiveValues ...string) string

func RedactTarget ¶

func RedactTarget(raw string) string

Types ¶

type AcquisitionCollector ¶ added in v0.2.0

type AcquisitionCollector struct {
	// contains filtered or unexported fields
}

AcquisitionCollector gathers records for one application render. It records unconditionally, independent of the --cache-events Recorder gating.

func NewAcquisitionCollector ¶ added in v0.2.0

func NewAcquisitionCollector() *AcquisitionCollector

func (*AcquisitionCollector) Record ¶ added in v0.2.0

func (c *AcquisitionCollector) Record(record AcquisitionRecord)

func (*AcquisitionCollector) Records ¶ added in v0.2.0

func (c *AcquisitionCollector) Records() []AcquisitionRecord

type AcquisitionErrorResult ¶

type AcquisitionErrorResult struct {
	Event         Event
	RedactedError string
}

func NewAcquisitionError ¶

func NewAcquisitionError(input AcquisitionEventInput) AcquisitionErrorResult

type AcquisitionEventInput ¶

type AcquisitionEventInput struct {
	Source            Source
	Target            string
	Revision          string
	RequestedRevision string
	Offline           bool
	Refresh           bool
	FromCache         bool
	Network           bool
	Err               error
	ErrorText         string
	RawTargets        []string
	SensitiveValues   []string
}

type AcquisitionKind ¶ added in v0.2.0

type AcquisitionKind string

AcquisitionKind classifies a mid-render acquisition for the persistent render cache pin-stability gate. Unlike Event.Source, it distinguishes remote git bases from remote HTTP files.

const (
	AcquisitionGit        AcquisitionKind = "git"
	AcquisitionChart      AcquisitionKind = "chart"
	AcquisitionRemoteGit  AcquisitionKind = "remote-git"
	AcquisitionRemoteHTTP AcquisitionKind = "remote-http"
)

type AcquisitionRecord ¶ added in v0.2.0

type AcquisitionRecord struct {
	Kind              AcquisitionKind
	RequestedRevision string
	ResolvedRevision  string
}

AcquisitionRecord retains the pre-collapse requested and resolved revisions of one successful acquisition. The user-facing Event collapses these into a single Revision field, so the pin-stability gate cannot consume Events.

type Action ¶

type Action string

const (
	ActionLocal    Action = "local"
	ActionMapped   Action = "mapped"
	ActionHit      Action = "hit"
	ActionFetch    Action = "fetch"
	ActionRefresh  Action = "refresh"
	ActionMiss     Action = "miss"
	ActionError    Action = "error"
	ActionDisabled Action = "disabled"
	ActionStore    Action = "store"
	ActionEvict    Action = "evict"
	ActionSkipped  Action = "skipped"
)

func ActionForAcquisition ¶

func ActionForAcquisition(fromCache bool, network bool, refresh bool) Action

func ActionForError ¶

func ActionForError(err error) Action

type Event ¶

type Event struct {
	Source          Source   `json:"source" yaml:"source"`
	Action          Action   `json:"action" yaml:"action"`
	Target          string   `json:"target,omitempty" yaml:"target,omitempty"`
	Revision        string   `json:"revision,omitempty" yaml:"revision,omitempty"`
	CacheHit        bool     `json:"cacheHit,omitempty" yaml:"cacheHit,omitempty"`
	Offline         bool     `json:"offline,omitempty" yaml:"offline,omitempty"`
	Refresh         bool     `json:"refresh,omitempty" yaml:"refresh,omitempty"`
	Error           string   `json:"error,omitempty" yaml:"error,omitempty"`
	Reason          string   `json:"reason,omitempty" yaml:"reason,omitempty"`
	RawTargets      []string `json:"-" yaml:"-"`
	SensitiveValues []string `json:"-" yaml:"-"`
}

func NewAcquisitionEvent ¶

func NewAcquisitionEvent(input AcquisitionEventInput) Event

type Recorder ¶

type Recorder struct {
	// contains filtered or unexported fields
}

func NewRecorder ¶

func NewRecorder(enabled bool) *Recorder

func (*Recorder) Enabled ¶

func (r *Recorder) Enabled() bool

func (*Recorder) Events ¶

func (r *Recorder) Events() []Event

func (*Recorder) Record ¶

func (r *Recorder) Record(event Event)

type Source ¶

type Source string

const (
	SourceGit    Source = "git"
	SourceChart  Source = "chart"
	SourceRemote Source = "remote"
	SourceRender Source = "render"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL