common

Documentation

Index

• Constants
• func AddCommonLabels(labels map[string]string)
• func FormatScrapedNamespaces(lc loggedcluster.Interface, namespaces []string) string
• func GetObservabilityBundleAppVersion(lc loggedcluster.Interface, client client.Client, ctx context.Context) (version semver.Version, err error)
• func GrafanaAgentExtraSecretName() string
• func IsLoggingEnabled(lc loggedcluster.Interface) bool
• func IsWorkloadCluster(lc loggedcluster.Interface) bool
• func ObservabilityBundleAppMeta(lc loggedcluster.Interface) metav1.ObjectMeta
• func ObservabilityBundleConfigMapMeta(lc loggedcluster.Interface) metav1.ObjectMeta
• func ReadProxyIngressURL(ctx context.Context, lc loggedcluster.Interface, client client.Client) (string, error)

Constants

const (
	// ReadUser is the global user for reading logs
	ReadUser = "read"

	// 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"
	PromtailObservabilityBundleLegacyAppName = "promtail-app"

	// 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"

	MaxBackoffPeriod = "10m"
	LokiURLFormat    = "https://%s/loki/api/v1/push"
)

const ObservabilityBundleAppName string = "observability-bundle"

Functions

func AddCommonLabels

func AddCommonLabels(labels map[string]string)

func FormatScrapedNamespaces

func FormatScrapedNamespaces(lc loggedcluster.Interface, namespaces []string) string

func GetObservabilityBundleAppVersion

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

func GrafanaAgentExtraSecretName

func GrafanaAgentExtraSecretName() string

func IsLoggingEnabled

func IsLoggingEnabled(lc loggedcluster.Interface) bool

func IsWorkloadCluster

func IsWorkloadCluster(lc loggedcluster.Interface) bool

func ObservabilityBundleAppMeta

func ObservabilityBundleAppMeta(lc loggedcluster.Interface) metav1.ObjectMeta

ObservabilityBundleAppMeta returns metadata for the observability bundle app.

func ObservabilityBundleConfigMapMeta

func ObservabilityBundleConfigMapMeta(lc loggedcluster.Interface) metav1.ObjectMeta

ObservabilityBundleConfigMapMeta returns metadata for the observability bundle extra values configmap.

func ReadProxyIngressURL

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

Read Proxy URL from ingress