Remove deprecated localhost debug config endpoint#6984
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #6984 +/- ##
==========================================
- Coverage 38.00% 37.83% -0.17%
==========================================
Files 367 366 -1
Lines 25713 25619 -94
==========================================
- Hits 9771 9694 -77
+ Misses 15128 15115 -13
+ Partials 814 810 -4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR removes the deprecated localhost debug config endpoint (http://localhost:55554/debug/configz) and all related environment variables (SPLUNK_DEBUG_CONFIG_SERVER and SPLUNK_DEBUG_CONFIG_SERVER_PORT). The functionality has been replaced by the expvarz endpoint available through the zpages extension.
Key changes:
- Deleted the
ConfigServerimplementation and its tests - Removed environment variable references from scripts and configuration files
- Moved redaction utility functions to the
ExpvarConverter - Updated test files to remove config server dependencies
Reviewed changes
Copilot reviewed 18 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/configconverter/config_server.go | Deleted deprecated ConfigServer implementation |
| internal/configconverter/config_server_test.go | Deleted ConfigServer tests |
| internal/configconverter/expvar.go | Added simpleRedact and shouldRedactKey utility functions |
| cmd/otelcol/main.go | Removed ConfigServer initialization and registration |
| cmd/otelcol/main_test.go | Updated port waits from 55554 to 55679 (zpages) |
| packaging/msi/splunk-support-bundle.ps1 | Removed localhost:55554 config collection |
| packaging/fpm/etc/otel/collector/splunk-support-bundle.sh | Removed localhost:55554 config collection |
| packaging/technical-addon/Splunk_TA_otel/windows_x86_64/bin/Splunk_TA_otel.cmd | Removed SPLUNK_DEBUG_CONFIG_SERVER environment variable handling |
| packaging/technical-addon/Splunk_TA_otel/linux_x86_64/bin/Splunk_TA_otel.sh | Removed SPLUNK_DEBUG_CONFIG_SERVER environment variable handling |
| packaging/technical-addon/Splunk_TA_otel/README/inputs.conf.spec | Removed splunk_debug_config_server parameter documentation |
| packaging/technical-addon/packaging-scripts/cicd-tests/envvars/envvartest.sh | Removed SPLUNK_DEBUG_CONFIG_SERVER test references |
| packaging/technical-addon/packaging-scripts/cicd-tests/envvars/passthrough_env_vars.yaml | Removed SPLUNK_DEBUG_CONFIG_SERVER passthrough configuration |
| tests/general/discoverymode/configd_test.go | Removed SPLUNK_DEBUG_CONFIG_SERVER=false from test command |
| tests/general/discoverymode/docker_observer_discovery_test.go | Removed SPLUNK_DEBUG_CONFIG_SERVER=false from test command |
| tests/general/discoverymode/host_observer_discovery_test.go | Removed SPLUNK_DEBUG_CONFIG_SERVER=false from test command |
| tests/general/configsources/vault_test.go | Updated comment to remove reference to config endpoint |
| .github/workflows/win-package-test.yml | Added working-directory specification for test commands |
| .github/workflows/scripts/win-required-ports.ps1 | Removed port 55554 reservation |
| go.mod | Removed unused test dependencies |
| go.sum | Removed checksums for unused dependencies |
| .chloggen/remove-config-debug-server.yaml | Added changelog entry for breaking change |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Are these working-directory changes related to this PR?
There was a problem hiding this comment.
Yes they are. Removal of the component triggered changes to go.mod, and those required the working-directory. To be fair I don't fully understand why that is the case, but after the changes to with go.mod and respective tidy this is the simplest fix that I found.
Co-authored-by: Curtis Robert <crobert@splunk.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 18 out of 21 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 18 out of 21 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 18 out of 21 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 18 out of 21 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description: Removed the deprecated localhost config endpoint and related environment variables.