state/remote/swift: Support Openstack request logging

[fatmcgav]

PR #12089 added support for logging request and response bodies to Openstack resource requests.
This PR extends that to the swift remote state backend.

In order to support this, had to modify the LogRoundTripper struct to use uppercase field names so that they are exposed externally of the package.

Also extended LogRoundTripper to log the request/response headers, as they are useful when working with Swift and container archiving/expiration which uses headers to specify, rather than the request body.

[fatmcgav]

@jtopjian Comments welcome.

[jtopjian]

Nice! I did a cursory review and it looks good. I'll take a look in more detail either today or tomorrow.

[fatmcgav]

Cheers... I just had a thought aswell.

Should LogRoundTripper be in util.go, rather than types.go?

[jtopjian]

@fatmcgav It could. The reason I have it in types.go is because it's a method to a type and it keeps everything bundled in one file. utils.go, IMO, is for standalone functions.

Thanks for this feature. Printing the headers is definitely useful, especially for Swift, but we should mask some of the sensitive headers printed. For example, when building an instance, this is now printed:

x-subject-token: gAAAAABY8DEPwc...
...
x-auth-token: gAAAAABY8DEPwc5AEjh...

I think masking the token with *** would be a better option.

Other than that, looks great 😄

[fatmcgav]

Cool, makes sense on location.

Masking sensitive headers makes sense. I'll refactor the printing of the headers and add some redaction logic...

Edit: having a look for a sensible list of headers to redact, I found:

• https://docs.openstack.org/developer/python-swiftclient/swiftclient.html#swiftclient.client.LOGGER_SENSITIVE_HEADERS

Looks like a sensible default list to me...

[fatmcgav]

@jtopjian I just pushed b3da653 which adds a RedactHeaders function.

Thoughts?

[jtopjian]

Awesome! Nice work :)

@stack72 This looks good to me.

[fatmcgav]

No worries... Happy to squash down the latest commit if cleaner...

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.