redpanda icon indicating copy to clipboard operation
redpanda copied to clipboard

rpk: debug bundle allow admins/customers to decode controller logs

Open jason-da-redpanda opened this issue 1 year ago • 0 comments

Who is this for and what problem do they have today?

  1. controller logs are in serde format and need to be decoded to view in text form with https://github.com/redpanda-data/redpanda/tree/dev/tools/offline_log_viewer

When working via a support ticket this means downloading the bundle files.. then manually running the python script ont the controller logs

Or .. asking customer to run the steps manually

rpk debug bundle should be able to do this via a flag .. at source

  1. Customers need to know what they are uploading to redpanda support. e.g their security teams might be concerned and want to know if anything sensitive is in these files and edit accordingly before uploading to redpanda

Once decoded (we should automatically redact any sensitive info from decoded controller logs) ... customers can also double check if anything in the files they do not want to be uploaded to redpanda

What are the success criteria?

rpk debug bundle has option to decode controller files ... (with any sensitive data redacted)

Why is solving this problem impactful?

Quicker turn around in support cases.. e.g customer uploads controllers via bundle.. we extract , run offline viewer etc.. this can be done at source

Additionally .....Some customers want to see what they are uploading to redpanda. controller logs are not in plain text

Additional notes

jason-da-redpanda avatar Feb 11 '24 13:02 jason-da-redpanda