[sos] Set a User Agent for s3 based uploads

[TrevorBenson]

Resolves: #3688

Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines

• Is the commit message split over multiple lines and hard-wrapped at 72 characters?
• Is the subject and message clear and concise?
• Does the subject start with [plugin_name] if submitting a plugin patch or a [section_name] if part of the core sosreport code?
• Does the commit contain a Signed-off-by: First Lastname [email protected]?
• Are any related Issues or existing PRs properly referenced via a Closes (Issue) or Resolved (PR) line?
• Are all passwords or private data gathered by this PR obfuscated?

---

I thought it might be best not to use the bare word config or Config for just the s3 uploader, so I adjusted them. I'm open to any suggestions, like making them similar (i.e. Boto3Config or botocore_config), or any preferred style suggested.

[packit-as-a-service]

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

• sudo yum install -y dnf-plugins-core on RHEL 8
• sudo dnf install -y dnf-plugins-core on Fedora
• dnf copr enable packit/sosreport-sos-3823
• And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

[arif-ali]

/packit rebuild-failed

[TrevorBenson]

/packit rebuild-failed

[jcastill]

LGTM
Just a thought, and please excuse my ignorance if it's not applicable... but would it be better to add an option for the command line that allows to set up an s3_user_agent? So the user could specify a user custom agent, use a default one (app/sos), or set None?

[TrevorBenson]

LGTM Just a thought, and please excuse my ignorance if it's not applicable... but would it be better to add an option for the command line that allows to set up an s3_user_agent? So the user could specify a user custom agent, use a default one (app/sos), or set None?

It is an option, but it wasn't discussed in the original issue #3688. It may be possible to use AWS_EXECUTION_ENV to achieve this, but I haven't tested it.

FWIW, I did not find examples that allow setting the user agent string via a flag in many s3 CLI applications. That is not to say they don't exist; Simply that I did not find them previously when looking.

[TrevorBenson]

@arif-ali rpm-build:fedora-41-ppc64le & rpm-build:fedora-41-s390x still displayed as if they were running 2 weeks after your message to packit. I asked packit to rebuild failures again, but they do not seem to progress.

[TrevorBenson]

I set it to app/sos because in a later version of boto3 (once Python 3.9 is the minimum supported version) the user_agent_appid="sos" would append "app/sos" to the user agent. This way in the future if or when sos migrates to using user_agent_appid the agent string for sos can remain consistent.

[arif-ali]

@arif-ali rpm-build:fedora-41-ppc64le & rpm-build:fedora-41-s390x still displayed as if they were running 2 weeks after your message to packit. I asked packit to rebuild failures again, but they do not seem to progress.

I don't thing it matters here much, as it's not based on your change, so all good imho. Maybe someone who knows pack will have better ideas

[arif-ali]

imho, user agent is not something that is changed in applications, and it is usually a definition of which application came through. In my opinion, having the option to change would not make sense, but that's my opinion.