Currently, this Ansible collection sets a User-Agent of ansible-equinix, and allows users to pass in a User-Agent prefix that will be added to the start of the User-Agent string. The SDK used by this collection provides its own default User-Agent which includes the SDK name and version. For monitoring purposes, it would be useful to include that default User-Agent in the final User-Agent string so that we can better track version adoption as well as usage of the underlying SDK.
A User-Agent satisfying this issue would look like one of these examples:
When the user specifies a User-Agent prefix: <user-agent-prefix> ansible-equinix <sdk-user-agent>
When the user does not specify a User-Agent prefix: ansible-equinix <sdk-user-agent>
Optionally, it would also be nice to include the collection version in the User-Agent token for this collection, i.e. ansible-equinix/<version>; I'm not clear how readily-available the collection version is at runtime.
SUMMARY
Currently, this Ansible collection sets a User-Agent of
ansible-equinix
, and allows users to pass in a User-Agent prefix that will be added to the start of the User-Agent string. The SDK used by this collection provides its own default User-Agent which includes the SDK name and version. For monitoring purposes, it would be useful to include that default User-Agent in the final User-Agent string so that we can better track version adoption as well as usage of the underlying SDK.A User-Agent satisfying this issue would look like one of these examples:
<user-agent-prefix> ansible-equinix <sdk-user-agent>
ansible-equinix <sdk-user-agent>
Optionally, it would also be nice to include the collection version in the User-Agent token for this collection, i.e.
ansible-equinix/<version>
; I'm not clear how readily-available the collection version is at runtime.ISSUE TYPE
COMPONENT NAME
API client configuration
ADDITIONAL INFORMATION
N/A; this wouldn't be a user-facing change