Backport(v1.19) in_monitor_agent: change default visibility of config, retry, and debug info#5392
Merged
Merged
Conversation
…ug info **Which issue(s) this PR fixes**: Fixes # **What this PR does / why we need it**: This PR updates the default behavior of the `monitor_agent` API to provide a more minimal and predictable response footprint. ### Before The HTTP API (`/api/plugins.json`, etc.) included `config`, `retry` state, and `instance_variables` of plugins by default (or when dynamically queried with parameters like `debug=1`, `with_config`, `with_retry`, or `with_ivars`). This resulted in unnecessarily verbose payloads that exposed deep internal plugin states not typically required for standard health monitoring. ### After Inclusion of these detailed internal states is now disabled by default to reduce payload size and enforce explicit configuration. * Changed * `include_config` default is changed from `true` to `false`. * `include_retry` default is changed from `true` to `false`. * The API no longer allows URL query parameters to override these settings. * Added * `include_debug_info` parameter to explicitly control the visibility of internal instance variables (default `false`). * Debug information (via queries such as `debug=1` or `with_ivars=xxx`) is now only included when this parameter is explicitly enabled in the configuration block. **Docs Changes**: **Release Note**: * in_monitor_agent: change default visibility of config, retry, and debug info Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
kenhys
changed the title
kenhys
approved these changes
Jun 25, 2026
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.
Which issue(s) this PR fixes:
Fixes #
What this PR does / why we need it:
This PR updates the default behavior of the
monitor_agentAPI to provide a more minimal and predictable response footprint.Before
The HTTP API (
/api/plugins.json, etc.) includedconfig,retrystate, andinstance_variablesof plugins by default (or when dynamically queried with parameters likedebug=1,with_config,with_retry, orwith_ivars).This resulted in unnecessarily verbose payloads that exposed deep internal plugin states not typically required for standard health monitoring.
After
Inclusion of these detailed internal states is now disabled by default to reduce payload size and enforce explicit configuration.
include_configdefault is changed fromtruetofalse.include_retrydefault is changed fromtruetofalse.include_debug_infoparameter to explicitly control the visibility of internal instance variables (defaultfalse).debug=1orwith_ivars=xxx) is now only included when this parameter is explicitly enabled in the configuration block.Docs Changes:
Release Note: