chore(k8s/cluster): add debug logging convention and helper#15
Open
rafeegnash wants to merge 1 commit intok8-gcp-supportfrom
Open
chore(k8s/cluster): add debug logging convention and helper#15rafeegnash wants to merge 1 commit intok8-gcp-supportfrom
rafeegnash wants to merge 1 commit intok8-gcp-supportfrom
Conversation
Add documentation for the debug logging format convention and a DebugLog helper function that can be used by providers. Debug logging convention: - Format: [provider] action: details - Provider tags should be lowercase - Examples: [eks], [gke], [kubeadm], [ssh], [kubectl] The DebugLog helper provides consistent formatting and respects the debug flag to suppress output when not in debug mode. Refs bgdnvk#75 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DebugLoghelper function for consistent formattingLogging Convention
All debug output should follow the pattern:
[provider] action: detailsExamples:
[eks] creating cluster: aws eks create-cluster --name test[gke] cluster test-cluster status: RUNNING[kubeadm] bootstrapping worker 1...[ssh] connecting to user@hostProvider tags:
[eks],[eksctl],[aws]- for EKS operations[gke],[gcloud]- for GKE operations[kubeadm]- for kubeadm operations[kubectl]- for kubectl operations[ssh]- for SSH operationsTest Plan
Closes bgdnvk#75