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

Document the log centralization system #2686

Closed
alexandre-allard opened this issue Jul 29, 2020 · 1 comment
Closed

Document the log centralization system #2686

alexandre-allard opened this issue Jul 29, 2020 · 1 comment
Labels
kind:enhancement New feature or request topic:docs Documentation topic:log Anything related to log centralization system

Comments

@alexandre-allard
Copy link
Contributor

Component: documentation

Why this is needed:
To explain what's the log centralization system is, how to interact and configure it.

What should be done:
The sizing section in Introduction page is updated to include log centralization service impact.
The sizing rule takes in account the retention period, workloads expected log rate and workload predefined indices.
This rule is to be known by solution developers to properly size the service based on the workload properties.
The Post Installation page is updated to indicate that persistent storage is needed for log centralization service.
A new page should be added to explains how to operate the service and how to forward logs to an external log centralization system.
The Cluster Monitoring page is updated to describe the log centralization service.

Implementation proposal (strongly recommended):

Test plan:

@alexandre-allard alexandre-allard added kind:enhancement New feature or request topic:docs Documentation topic:log Anything related to log centralization system labels Jul 29, 2020
@alexandre-allard
Copy link
Contributor Author

Already done and sizing rules are to be defined in Solutions documentation because they greatly depend on the applications (still we have a dumb pretty pessimistic rule in our documentation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:enhancement New feature or request topic:docs Documentation topic:log Anything related to log centralization system
Projects
None yet
Development

No branches or pull requests

1 participant