docs: add README for request-metadata-extractor plugin - #313
Open
magic-peach wants to merge 1 commit into
Open
magic-peach wants to merge 1 commit into
magic-peach wants to merge 1 commit into
Conversation
Documents purpose, event handling, the request-metadata attribute, known counter-leak limitation, and concurrency assumptions, matching the format used by other plugin READMEs in this repo. Signed-off-by: Akanksha Trehun <akankshatrehun@gmail.com>
github-actions
Bot
added
size/M
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.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Adds a
README.mdfor therequest-metadata-extractordatalayer plugin (pkg/framework/plugins/datalayer/requestmetadata/), which had none. The directory previously only hadplugin.goandplugin_test.go. The new README documents what the plugin does, how it processesRequestEventTypeandResponseEventTypeevents, therequest-metadataattribute it writes, the counter-leak limitation already called out in the plugin's own doc comment, and its single-goroutine concurrency assumption, following the same format used by the other plugin READMEs in this repo (for examplerequestcostmetadata/README.mdandmodelconfigcollector/README.md).Which issue(s) this PR fixes:
Fixes #194
Release note (write
NONEif no user-facing change):