-
Notifications
You must be signed in to change notification settings - Fork 17
K8SPSMDB-297 Documented cluster-level logging #255
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR documents cluster-level logging functionality for the Percona Operator for MongoDB, explaining how logs are persistently stored and managed in Kubernetes environments.
- Adds comprehensive documentation for cluster-level logging feature
- Explains how Fluent Bit is used as a sidecar container for log collection
- Documents configuration options and behavior for the log collector
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
docs/debug-logs.md
Outdated
Percona Operator for MongoDB addresses this challenge with **cluster-level logging**, ensuring logs are stored persistently, independent of the Pods. This approach helps ensure that logs are available for review even after a Pod restarts. | ||
The Operator collects logs using [Fluent Bit :octicons-link-external-16:] - a lightweight log processor, which supports many output plugins and has broad forwarding capabilities. Fluent Bit runs as a sidecar container within each database Pod. It collects logs from the primary `mongod` container, adds metadata, and stores them in a single file in a dedicated log-specific Persistent Volume Claim (PVC) at `/data/db/logs/`. This allows logs to survive Pod restarts and be accessed for later debugging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The Fluent Bit link appears to be using a syntax for external links that may not render correctly in all markdown processors. Consider using standard markdown link syntax like [Fluent Bit](https://fluentbit.io/)
or verify that the :octicons-link-external-16:
syntax is supported by your documentation system.
The Operator collects logs using [Fluent Bit :octicons-link-external-16:] - a lightweight log processor, which supports many output plugins and has broad forwarding capabilities. Fluent Bit runs as a sidecar container within each database Pod. It collects logs from the primary `mongod` container, adds metadata, and stores them in a single file in a dedicated log-specific Persistent Volume Claim (PVC) at `/data/db/logs/`. This allows logs to survive Pod restarts and be accessed for later debugging. | |
The Operator collects logs using [Fluent Bit](https://fluentbit.io/) - a lightweight log processor, which supports many output plugins and has broad forwarding capabilities. Fluent Bit runs as a sidecar container within each database Pod. It collects logs from the primary `mongod` container, adds metadata, and stores them in a single file in a dedicated log-specific Persistent Volume Claim (PVC) at `/data/db/logs/`. This allows logs to survive Pod restarts and be accessed for later debugging. |
Copilot uses AI. Check for mistakes.
You can additionally configure Fluent Bit using the `logcollector.configuration` subsection in | ||
the `deploy/cr.yaml` Custom Resource manifest. This allows you to define custom filters and output plugins to suit your specific logging and monitoring needs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The sentence is broken across two lines unnecessarily. Consider joining these lines for better readability: 'You can additionally configure Fluent Bit using the logcollector.configuration
subsection in the deploy/cr.yaml
Custom Resource manifest.'
You can additionally configure Fluent Bit using the `logcollector.configuration` subsection in | |
the `deploy/cr.yaml` Custom Resource manifest. This allows you to define custom filters and output plugins to suit your specific logging and monitoring needs. | |
You can additionally configure Fluent Bit using the `logcollector.configuration` subsection in the `deploy/cr.yaml` Custom Resource manifest. This allows you to define custom filters and output plugins to suit your specific logging and monitoring needs. |
Copilot uses AI. Check for mistakes.
modified: docs/debug-logs.md
0612256
to
994d75e
Compare
docs/debug-logs.md
Outdated
You can additionally configure Fluent Bit using the `logcollector.configuration` subsection in | ||
the `deploy/cr.yaml` Custom Resource manifest. This allows you to define custom filters and output plugins to suit your specific logging and monitoring needs. | ||
When you add a new configuration to the `logcollector.configuration` and this field was previously empty, it triggers a Smart Update. However, if the configuration was not empty, subsequent changes won't trigger an update automatically. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, if the configuration was not empty, subsequent changes won't trigger an update automatically.
If we have a non-empty configuration and we update it for some reason, after applying the changes we will trigger the update without a problem!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So in any case we trigger the cluster update?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, update is triggered in either case
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
modified: docs/debug-logs.md