Allow the user-agent to be overridden #277
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow the user-agent to be overridden by 3rd party developers of the runtime-interface-client.
Issue #, if available:
None
Description of changes:
When the aws-lambda-java-runtime-interface-client makes requests to the Lambda Runtime API it does them with a specific user-agent. This allows tracking and analysis of the clients and their versions.
Now that the aws-lambda-java-runtime-interface-client is being used by 3rd party framework developers it would be advantageous to be able to differentiate them.
This change introduces two additional ways that the user-agent can be overridden from the default. The original implementation sends 3 strings in the following format '%s/%s-%s'.
The proposal allows for an override of the first string 'aws-lambda-java' if the env var 'RUNTIME_CLIENT' is present. If it is not then the default of 'aws-lambda-java' is used.
An override of the third string which is the pom version id with the env var 'RUNTIME_CLIENT_VERSION' if it is present. If it is not then the original implementation is used.
This change will introduce no changes to the user-agent for typical usage. It will allow 3rd party framework developers to set environment variables in bootstrap scripts to override the user-agent.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.