common

package
v0.29.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// ReadUser is the global user for reading logs
	ReadUser = "read"
	// DefaultWriteTenant is the default tenant for writing logs
	DefaultWriteTenant = "giantswarm"

	// Possible values for --logging-agent flag.
	LoggingAgentPromtail = "promtail"
	LoggingAgentAlloy    = "alloy"

	// Possible values for --events-logger flag.
	EventsLoggerAlloy        = "alloy"
	EventsLoggerGrafanaAgent = "grafana-agent"

	// App name keys in the observability bundle
	AlloyObservabilityBundleAppName    = "alloyLogs"
	PromtailObservabilityBundleAppName = "promtail"

	// Alloy app name and namespace when using Alloy as logging agent.
	AlloyLogAgentAppName      = "alloy-logs"
	AlloyLogAgentAppNamespace = "kube-system"

	// Alloy app name and namespace when using Alloy as events logger.
	AlloyEventsLoggerAppName      = "alloy-events"
	AlloyEventsLoggerAppNamespace = "kube-system"

	// LokiMaxBackoffPeriod specifies the maximum retry backoff duration for Loki writes.
	LokiMaxBackoffPeriod = 10 * time.Minute
	// LokiRemoteTimeout configures the write timeout for remote Loki endpoints.
	LokiRemoteTimeout = 60 * time.Second

	LokiBaseURLFormat = "https://%s"

	LokiPushURLFormat = LokiBaseURLFormat + lokiAPIV1PushPath

	LoggingURL      = "logging-url"
	LoggingTenantID = "logging-tenant-id"
	LoggingUsername = "logging-username"
	LoggingPassword = "logging-password"
	LokiRulerAPIURL = "ruler-api-url"
)

Variables

This section is empty.

Functions

func AddCommonLabels

func AddCommonLabels(labels map[string]string)

func GetObservabilityBundleAppVersion added in v0.5.1

func GetObservabilityBundleAppVersion(ctx context.Context, client client.Client, lc loggedcluster.Interface) (version semver.Version, err error)

func GrafanaAgentExtraSecretName added in v0.2.0

func GrafanaAgentExtraSecretName() string

func IsLoggingEnabled

func IsLoggingEnabled(lc loggedcluster.Interface) bool

func IsWorkloadCluster added in v0.0.4

func IsWorkloadCluster(lc loggedcluster.Interface) bool

func ObservabilityBundleAppMeta added in v0.1.3

func ObservabilityBundleAppMeta(lc loggedcluster.Interface) metav1.ObjectMeta

ObservabilityBundleAppMeta returns metadata for the observability bundle app.

func ObservabilityBundleConfigMapMeta added in v0.1.3

func ObservabilityBundleConfigMapMeta(lc loggedcluster.Interface) metav1.ObjectMeta

ObservabilityBundleConfigMapMeta returns metadata for the observability bundle extra values configmap.

func ReadLokiIngressURL added in v0.2.0

func ReadLokiIngressURL(ctx context.Context, lc loggedcluster.Interface, client client.Client) (string, error)

Read Loki URL from ingress

func ToggleAgents added in v0.25.0

func ToggleAgents(ctx context.Context, client client.Client, lc loggedcluster.Interface) error

Types

This section is empty.

Jump to

Keyboard shortcuts

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