diagnostics

type AffectedObject struct {
	// UID is the unique identifier of the object.
	UID k8stypes.UID

	// Group is the object's group.
	Group string
	// Kind is the object's Kind.
	Kind string
	// Namespace is the object's Namespace.
	Namespace string
	// Name is the object's Name.
	Name string
}

type Client struct {
	// DumpsIncludeSensitive is true if the configuration dump includes sensitive values, such as certificate private
	// keys and credential secrets.
	DumpsIncludeSensitive bool

	// Configs is the channel that receives configuration blobs from the configuration update strategy implementation.
	Configs chan ConfigDump

	// FallbackCacheMetadata is the channel that receives fallback metadata from the fallback cache generator.
	FallbackCacheMetadata chan fallback.GeneratedCacheMetadata

	// Diffs is the channel that receives diff info in DB mode.
	Diffs chan ConfigDiff
}

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

type ConfigDiff struct {
	Hash      string       `json:"hash"`
	Entities  []EntityDiff `json:"entities"`
	Timestamp string       `json:"timestamp"`
}

type ConfigDump struct {
	// Config is the configuration KIC applied or attempted to apply.
	Config file.Content
	// Meta contains information about the status and context of the configuration dump.
	Meta DumpMeta
	// RawResponseBody is the raw Kong Admin API response body from a config apply. It is only available in DB-less mode.
	RawResponseBody []byte
}

type ConfigDumpResponse struct {
	ConfigHash string       `json:"hash"`
	Config     file.Content `json:"config"`
}

type DiffIndex struct {
	// ConfigHash is the config hash for the associated diff.
	ConfigHash string `json:"hash"`
	Timestamp  string `json:"timestamp"`
}

type DiffResponse struct {
	// Message provides explanatory information, if any.
	Message string `json:"message,omitempty"`
	// ConfigHash is the config hash for the associated diffs.
	ConfigHash string `json:"hash"`
	// Timestamp is the time this diff was received by the diff server. This is roughly the time the sync operation
	// completed. May be a second or so after the last gateway API call, since it's taken when KIC finishes processing
	// GDR events.
	Timestamp string `json:"timestamp"`
	// Diffs are the diffs for modified objects.
	Diffs []EntityDiff `json:"diffs"`
	// Available lists the currently available diff hashes and timestamps.
	Available []DiffIndex `json:"available"`
}

type DumpMeta struct {
	// Failed indicates the dump was not accepted by the Kong admin API.
	Failed bool
	// Fallback indicates that the dump is a fallback configuration attempted after a failed config update.
	Fallback bool
	// Hash is the configuration hash.
	Hash string
}

type EntityDiff struct {
	Generated GeneratedEntity `json:"kongEntity"`
	Action    string          `json:"action"`
	Diff      string          `json:"diff,omitempty"`
}

type FallbackAffectedObjectMeta struct {
	// Group is the resource group.
	Group string `json:"group"`
	// Kind is the resource kind.
	Kind string `json:"kind"`
	// Version is the resource version.
	Version string `json:"version,omitempty"`
	// Namespace is the object namespace.
	Namespace string `json:"namespace"`
	// Namespace is the object name.
	Name string `json:"name"`
	// ID is the object UID.
	ID string `json:"id"`
	// CausingObjects is the object that triggered this
	CausingObjects []string `json:"causingObjects,omitempty"`
}

type FallbackResponse struct {
	// Status is the fallback configuration generation status.
	Status FallbackStatus `json:"status"`
	// BrokenObjects is the list of objects that are broken.
	BrokenObjects []FallbackAffectedObjectMeta `json:"brokenObjects,omitempty"`
	// ExcludedObjects is the list of objects that were excluded from the fallback configuration.
	ExcludedObjects []FallbackAffectedObjectMeta `json:"excludedObjects,omitempty"`
	// BackfilledObjects is the list of objects that were backfilled from the last valid cache state.
	BackfilledObjects []FallbackAffectedObjectMeta `json:"backfilledObjects,omitempty"`
}

type FallbackStatus string

type GeneratedEntity struct {
	// Name is the name of the entity.
	Name string `json:"name"`
	// Kind is the type of entity.
	Kind string `json:"kind"`
}

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

type Provider interface {
	LastSuccessfulConfigDump() (file.Content, string, bool)
	LastFailedConfigDump() (file.Content, string, bool)
	LastErrorBody() ([]byte, bool)

	CurrentFallbackCacheMetadata() mo.Option[fallback.GeneratedCacheMetadata]

	LastConfigDiffHash() string
	ConfigDiffByHash(string) (ConfigDiff, bool)
	AvailableConfigDiffsHashes() []DiffIndex
}

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

type ServerConfig struct {
	// ProfilingEnabled enables Golang profiling endpoints under /debug/pprof/ prefix.
	ProfilingEnabled bool

	// DumpSensitiveConfig makes config dumps to include sensitive information.
	DumpSensitiveConfig bool

	// ListenerPort is the port the diagnostics server will listen on.
	ListenerPort int
}

type ServerOption func(*Server)