Add documentation for CloudFoundry application metadata persistent cache#22669
Merged
ycombinator merged 2 commits intoelastic:masterfrom Nov 23, 2020
ycombinator:cf-persistent-cache-doc
Merged
Add documentation for CloudFoundry application metadata persistent cache#22669ycombinator merged 2 commits intoelastic:masterfrom ycombinator:cf-persistent-cache-doc
ycombinator merged 2 commits intoelastic:masterfrom
ycombinator:cf-persistent-cache-doc
Conversation
Contributor
|
Pinging @elastic/integrations-platforms (Team:Platforms) |
Contributor
💚 Build Succeeded
Expand to view the summary
Build stats
❕ Flaky test reportNo test was executed to be analysed. |
jsoriano
approved these changes
Nov 19, 2020
Member
jsoriano
left a comment
There was a problem hiding this comment.
Looks good, added a suggestion but may be something obvious 🙂 so feel free to ignore it.
| For efficient annotation, application metadata retrieved by the Cloud Foundry | ||
| client is stored in a persistent cache on the filesystem under the `path.data` | ||
| directory. For control over this cache, use the `cache_duration` and | ||
| `cache_retry_delay` settings. |
Member
There was a problem hiding this comment.
Maybe we should mention that this is intended to persist metadata between restarts, and for that the data directory should be preserved.
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
3 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.
What does this PR do?
This PR documents the CloudFoundry application metadata persistent cache feature implemented in #20775.
Why is it important?
So users of the
add_cloudfoundry_metadataprocessors know about the persistent cache.Checklist
My code follows the style guidelines of this projectI have commented my code, particularly in hard-to-understand areasI have made corresponding change to the default configuration filesI have added tests that prove my fix is effective or that my feature worksI have added an entry inCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.Related issues