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

docs(log-collector): add warning banner post-execution for log collector #2174

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

ndbaker1
Copy link
Member

@ndbaker1 ndbaker1 commented Mar 6, 2025

Issue #, if available:

Description of changes:

This PR adds a banner to notify users they may want to redact potentially sensitive data in their log bundles.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Testing Done

ran on a test instance

> sudo ./log-collector-script/linux/eks-log-collector.sh

	This is version 0.7.8. New versions can be found at https://github.com/awslabs/amazon-eks-ami/blob/main/log-collector-script/

Trying to collect common operating system logs...
Trying to collect kernel logs...
Trying to collect modinfo... Trying to collect mount points and volume information...
Trying to collect SELinux status...
Trying to collect iptables information...
Trying to collect installed packages...
...TRUNCATED...
Trying to Collect sandbox-image daemon information...
Trying to Collect CPU Throttled Process Information...
Trying to Collect IO Throttled Process Information...
Trying to Collect reboot history...
Trying to Collect Nvidia Bug report... No Nvidia drivers found, nothing to do.

Trying to archive gathered information...

	Done... your bundled logs are located in /var/log/eks_i-049d185b673566680_2025-03-06_1822-UTC_0.7.8.tar.gz

****************************************************************************************
* WARNING: The log bundle collected by this script may contain sensitive information.  *
*                                                                                      *
* Please review the contents of the log bundle carefully and redact or obfuscate       *
* any information you do not wish to be accessible before sharing it with others.      *
****************************************************************************************

See this guide for recommended testing for PRs. Some tests may not apply. Completing tests and providing additional validation steps are not required, but it is recommended and may reduce review time and time to merge.

@cartermckinnon cartermckinnon merged commit df4dd7e into awslabs:main Mar 6, 2025
11 checks passed
@ndbaker1 ndbaker1 deleted the banner branch March 6, 2025 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants