Document lookup function debug logging#2133
Open
promptless-for-oss wants to merge 9 commits into
Open
Conversation
Document debug logging messages that help users diagnose why the lookup function returns empty results. Covers messages for not found objects, empty list queries, and missing Kubernetes client connection. Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
Updates the documented debug log messages to match the actual implementation in helm/helm PR #32205: - "lookup: resource not found" for single-object lookups - "lookup: resource list not found" for list lookups Removes the previously documented "no Kubernetes client available" message which is not part of the current implementation. Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
The functions_and_pipelines file uses .mdx extension in the docs/ (v4) directory. Signed-off-by: promptless[bot] <promptless[bot]@users.noreply.github.com>
| This provides a quick way of viewing the generated content without YAML parse | ||
| errors blocking. | ||
|
|
||
| ## Debugging the `lookup` function |
Contributor
Author
There was a problem hiding this comment.
Added the "Debugging the lookup function" section based on PR #32205, which adds slog.Debug() calls in pkg/engine/lookup_func.go when apierrors.IsNotFound is true. The debug messages include apiVersion, kind, namespace, and name fields.
Source: helm/helm#32205
| This provides a quick way of viewing the generated content without YAML parse | ||
| errors blocking. | ||
|
|
||
| ## Debugging the `lookup` function |
Contributor
Author
There was a problem hiding this comment.
Added the "Debugging the lookup function" section for version-3 docs based on PR #32205, which adds slog.Debug() calls when lookup returns not found. Also applies to Helm 3.x releases since the PR was merged to main.
Source: helm/helm#32205
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.
Open this suggestion in Promptless to view citations and reasoning process
Adds a new section to the Debugging Templates guide explaining how to use debug mode to diagnose why the lookup function returns empty results. Documents the debug log messages and common causes for both single-object and list lookups.
Trigger Events
Tip: Use Vale? Add your vale.ini when setting up your Docs Collection.