[8.5] [Profiling] Add APIs to clear frame and executable caches (#145499) #145524
Conversation
This file contains 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
…5499) This PR adds two endpoints to clear each respective cache: * `DELETE {BASE_KIBANA_PATH}/api/profiling/v1/cache/executables` * `DELETE {BASE_KIBANA_PATH}/api/profiling/v1/cache/stackframes` Related to https://github.com/elastic/prodfiler/issues/2759 #### Design choices 1. The `DELETE` method was chosen instead of `PUT` or `POST` since the given semantics of `DELETE` matches the expected behavior for the related issue. 2. Each endpoint will remove all items from the respective cache. A separate API for each cache allows us to selectively clear the necessary cache without the downsides of a catch-all endpoint to clear all caches. This gives us the flexibility to add more endpoints if needed. Given the tradeoff between complexity now or later, it was decided to implement general invalidation now with the option to invalidate specific items later. 3. The RESTful design allows us to clear specific items later (e.g. `DELETE {BASE_KIBANA_PATH}/api/profiling/v1/cache/executables/{ID}` could clear only executable `ID` from the cache). 4. Each endpoint returns an empty payload on success. However, the Kibana logs reflect the actions taken and how many cache items were affected. 5. The stacktrace cache was ignored since it was not affected by symbols written to Elasticsearch. 6. Each endpoint is not directly accessible from UI since it is expected that the endpoints will be called outside of Kibana. However, the endpoints can be called manually from the browser's console. (cherry picked from commit 642ab74)
💚 Build Succeeded
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: cc @jbcrail |
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.
Backport
This will backport the following commits from
mainto8.5:Questions ?
Please refer to the Backport tool documentation