[HTTP] Log deprecated API usages #199616
Assignees
Labels
Feature:http
Team:Core
Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
v9.0.0
Comments
jloleysens
added
Feature:http
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
This was referenced Jan 22, 2025
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Jan 28, 2025
## Summary Resolves elastic#199616 Added a debug logger when calling deprecated APIs. This logger is disabled by default, to enable it you have to set `deprecation.enable_http_debug_logs: true`. To test this you can play with the config value and do a request like this to a deprecated endpoint: ```shell #!/bin/bash API_KEY="" curl -X GET "http://localhost:5601/api/cases/status" -i \ -H "Content-Type: application/json" \ -H "Authorization: ApiKey $API_KEY" ``` ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: florent-leborgne <florent.leborgne@elastic.co> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com> (cherry picked from commit 23b7f0f)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Since we now track deprecated Kibana API usage (#196081) we should also create a (debug) log to help track down origins of requests.
We should have Kibana configuration for turning on this logging in a way that does not flood log output with all HTTP req/res traffic and instead only surfaces deprecations - similar to what we do when detecting deprecated ES API requests from Kibana (code).
We should be able to use existing debug logging logic for these new debug logs.
Additionally, API integrations should be able to send a user-provided value that we can surface when this logging is activated to provide the best experience for tracking down origins of deprecated usage.
Part of implementation: we should also surface this in public docs.
Open questions:
x-opaque-id(similar to ES) to provide the "user input" for the log?Potential place to add the logger:
kibana/src/core/packages/deprecations/server-internal/src/routes/post_validation_handler.ts
Line 51 in 6049493
We also want to keep the logger disabled until a specific setting is enabled (
http.log_deprecations: true).The text was updated successfully, but these errors were encountered: