Documentation
¶
Overview ¶
Package labels provides constant definitions for Kubernetes labels used across the Choreo logging system. This centralizes label definitions to eliminate magic strings and improve maintainability.
Index ¶
Constants ¶
const ( // ComponentID identifies the specific microservice/component ComponentID = "openchoreo.dev/component-uid" // EnvironmentID identifies the deployment environment (dev, test, staging, prod, etc.) EnvironmentID = "openchoreo.dev/environment-uid" // ProjectID identifies the project that groups multiple components ProjectID = "openchoreo.dev/project-uid" // Version is the human-readable version string (e.g., "v1.2.3") Version = "version" // VersionID is the unique deployment version identifier (UUID) VersionID = "version_id" // OrganizationUUID identifies the organization that owns the resources OrganizationUUID = "organization-name" // PipelineID identifies the CI/CD pipeline that deployed the component PipelineID = "pipeline-id" // RunID identifies the specific execution run of a pipeline RunID = "run_id" // WorkflowName identifies the build/deployment workflow WorkflowName = "workflow_name" // BuildID identifies the specific build instance BuildID = "build-name" // BuildUUID identifies the unique build identifier (UUID) BuildUUID = "uuid" // Target identifies the target log category (build, runtime, gateway) Target = "target" )
Kubernetes label keys used for log filtering and identification across all logging components. These labels are applied to Kubernetes resources and used by: - OpenSearch queries for log filtering - AWS CloudWatch log queries - Azure Log Analytics queries - Log enrichment processes
const ( // TargetBuild identifies build logs TargetBuild = "build" // TargetRuntime identifies runtime logs TargetRuntime = "runtime" // TargetGateway identifies gateway logs TargetGateway = "gateway" )
Target value constants for different log types
const ( // QueryParamLogTypeBuild identifies build log queries QueryParamLogTypeBuild = "BUILD" // QueryParamLogTypeRuntime identifies runtime log queries QueryParamLogTypeRuntime = "RUNTIME" )
Query parameter constants for log types
const ( // KubernetesLabelsPrefix is the base path for all Kubernetes labels in OpenSearch documents KubernetesPrefix = "kubernetes" KubernetesLabelsPrefix = KubernetesPrefix + ".labels" KubernetesPodName = KubernetesPrefix + ".pod_name" // Full field paths for OpenSearch queries OSComponentID = KubernetesLabelsPrefix + "." + ComponentID OSEnvironmentID = KubernetesLabelsPrefix + "." + EnvironmentID OSProjectID = KubernetesLabelsPrefix + "." + ProjectID OSVersion = KubernetesLabelsPrefix + "." + Version OSVersionID = KubernetesLabelsPrefix + "." + VersionID OSOrganizationUUID = KubernetesLabelsPrefix + "." + OrganizationUUID OSPipelineID = KubernetesLabelsPrefix + "." + PipelineID OSRunID = KubernetesLabelsPrefix + "." + RunID OSWorkflowName = KubernetesLabelsPrefix + "." + WorkflowName OSBuildID = KubernetesLabelsPrefix + "." + BuildID OSBuildUUID = KubernetesLabelsPrefix + "." + BuildUUID OSTarget = KubernetesLabelsPrefix + "." + Target )
OpenSearch field paths for querying Kubernetes labels in log documents
Variables ¶
var CICDLabels = []string{ PipelineID, RunID, WorkflowName, }
CICDLabels are the CI/CD related labels used for build and deployment log tracking
var RequiredLabels = []string{ ComponentID, EnvironmentID, ProjectID, }
RequiredLabels are the required labels that must be present on all Choreo components for proper log filtering
var VersioningLabels = []string{ Version, VersionID, }
VersioningLabels are the versioning labels used for deployment tracking and rollback scenarios
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files