Enable Log Collection for Failing Pods
This page describes how to enable and use the Cluster Agent feature to collect logs for failing pods. This feature is automatically enabled on SaaS Controllers. You must enable on-premises Controllers described on this page.
When enabled, the Cluster Agent automatically collects logs for restarted or failed pods. The pod failure logs capture the status of the CrashLoopBackoff Back-off restarting failed container
Minimum Requirements
The Cluster Agent log collection feature requires:
- Cluster Agent >= 20.7
- Controller >= 20.10.0
Controller Settings
The following table lists the log settings that the technical support team can update:
sim.cluster.logs.cloudstore.enabled or sim.cluster.logs.s3.enabled flag or the bucket name configuration requires a controller restart. Since controller restarts are managed internally, customers must contact the Support team to make these changes.
| Setting | Definition | Location | Default |
|---|---|---|---|
|
sim.cluster.logs.bucket.name |
The folder name to store the pod logs. |
Controller Administration Console with root user permission (Controller Settings) |
kubernetes-log-snippets |
|
sim.cluster.logs.capture.enabled |
An option to activate or deactivate log capturing. This option is enabled by default. |
Controller Administration Console with root user permission You can configure this setting at both account level (Account Settings) and Controller level (Controller Settings) |
true |
|
sim.cluster.logs.expiration.in.days |
The number of days after which the logs get cleared from the storage. | Controller Administration Console with root user permission (Controller Settings) | 10 |
|
sim.cluster.logs.root.file.path |
The complete root file path to store the logs.Modifying the path results in storing the logs in the new path but the older logs will remain in the previous location. | Controller Administration Console with root user permission (Controller Settings) | /opt/appdynamics |
sim.cluster.failed.pod.limit |
The number of historical pods beyond this value is purged. | Controller Administration Console with root user permission (Controller Settings) | 1000 |
sim.cluster.logs.cloudstore.enabled |
By default, uploaded pod logs are stored on the controller filesystem. Use this setting to switch to AWS cloud storage (or revert back to the filesystem).
Note: You require to restart the Controller to apply changes after modifying this setting.
|
Controller Administration Console with root user permission (Controller Settings) | false |
sim.cluster.logs.s3.enabled |
An option to save the logs in the S3 bucket. If you specify the value as false, the logs are saved in the Controller filesystem.
Note:
|
Controller Administration Console with root user permission (Controller Settings) | true |