docs: add documentation for filters and optional analyzers#775
Merged
AlexsJones merged 1 commit intok8sgpt-ai:mainfrom Jan 8, 2026
Merged
Conversation
Add documentation explaining how to use the filters field to enable optional analyzers like Log and HorizontalPodAutoscaler. Changes: - Add "Filters (Analyzers)" section to README.md with: - List of core analyzers (enabled by default) - List of optional analyzers (disabled by default) - Explanation that filters replace defaults - Usage examples - Update exhaustive_sample.yaml with inline comments about available analyzers - Add new filters_example.yaml sample file Fixes k8sgpt-ai#685 Signed-off-by: nikos.nikolakakis <nonickedgr@gmail.com>
NoNickeD
force-pushed
the
docs/685-filters-analyzers-documentation
branch
from
00f6480 to
f654a82
Compare
AlexsJones
approved these changes
Jan 8, 2026
Member
|
Thanks @NoNickeD :) |
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
2 participants
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
This PR adds documentation explaining how to use the
filtersfield to enable optional analyzers such asLog(logAnalyzer) andHorizontalPodAutoscaler(hpaAnalyzer).Changes
config/samples/exhaustive_sample.yamlwith inline comments listing available analyzersconfig/samples/filters_example.yamlsample file demonstrating filters usageProblem
Users were unable to determine how to enable optional analyzers like
logAnalyzerorhpaAnalyzerwhen using the K8sGPT Operator. The existing documentation did not explain:Fixes #685
Test plan