Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for CloudFoundry application metadata persistent cache #22669

Merged
merged 2 commits into from
Nov 23, 2020

Conversation

ycombinator
Copy link
Contributor

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_metadata processors know about the persistent cache.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Related issues

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Nov 19, 2020
@ycombinator ycombinator added [zube]: In Review docs Team:Platforms Label for the Integrations - Platforms team labels Nov 19, 2020
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Nov 19, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations-platforms (Team:Platforms)

@elasticmachine
Copy link
Collaborator

elasticmachine commented Nov 19, 2020

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #22669 updated]

  • Start Time: 2020-11-19T15:49:49.286+0000

  • Duration: 9 min 25 sec

❕ Flaky test report

No test was executed to be analysed.

Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should mention that this is intended to persist metadata between restarts, and for that the data directory should be preserved.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ will add.

Copy link
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@ycombinator ycombinator merged commit a91df7c into elastic:master Nov 23, 2020
@ycombinator ycombinator added v7.11.0 v8.0.0 needs_backport PR is waiting to be backported to other branches. v7.10.1 labels Nov 23, 2020
ycombinator added a commit to ycombinator/beats that referenced this pull request Nov 23, 2020
…che (elastic#22669)

* Add documentation for CF application metadata persistent cache

* Add explanation for metadata persistent cache
ycombinator added a commit to ycombinator/beats that referenced this pull request Nov 23, 2020
…che (elastic#22669)

* Add documentation for CF application metadata persistent cache

* Add explanation for metadata persistent cache
@ycombinator ycombinator removed the needs_backport PR is waiting to be backported to other branches. label Nov 23, 2020
ycombinator added a commit that referenced this pull request Nov 23, 2020
…che (#22669) (#22709)

* Add documentation for CF application metadata persistent cache

* Add explanation for metadata persistent cache
ycombinator added a commit that referenced this pull request Nov 23, 2020
…che (#22669) (#22708)

* Add documentation for CF application metadata persistent cache

* Add explanation for metadata persistent cache
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Cloudfoundry] Document local persistent cache
3 participants