feat: add result collection debug logging #33
Conversation
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
JacobPEvans
force-pushed
the
feat/enhanced-result-collection-debugging
branch
2 times, most recently
from
ecffb85 to
423c800
Compare
Add debug output before each result fetch showing: - Current offset position - Configured limit (page size) - Total events collected so far This provides visibility into the result collection loop when troubleshooting search behavior. Output uses distinct sourcetype 'goatsearch:debug' for easy filtering. Zero overhead when debug=False.
JacobPEvans
force-pushed
the
feat/enhanced-result-collection-debugging
branch
from
423c800 to
b5abefe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds a single debug output point in the result collection loop to aid troubleshooting.
When
debug=True, emits a debug event before each result fetch showingresults_uriwhich contains:uri: Cribl URLjob_id: search job idapi_limit: Configured API page size limitoffset: Current position in result setMotivation
When investigating search behavior or performance, having visibility into the result collection loop iterations is valuable. This makes it easier to:
Implementation
requests.get()callgoatsearch:debugfor easy filteringdebug=False(conditional branch not taken)Testing
Manual testing with
debug=Trueconfirms the debug events are emitted correctly and provide the expected visibility into collection behavior.🤖 Generated with Claude Code