aws / aws-sdk-go-v2

AWS SDK for the Go programming language.
https://aws.github.io/aws-sdk-go-v2/docs/
Apache License 2.0
2.68k stars 651 forks source link

Documentation says what not to do, but not what to do #2780

Closed markus-gerstel-sp closed 2 months ago

markus-gerstel-sp commented 2 months ago

Describe the issue

AWS Go SDK v2 states the following

Although you can change some of these configuration values, the default HTTP client and transport are not sufficiently configured for customers using the AWS SDK for Go V2 in an environment with high throughput and low latency requirements.

(emphasis mine)

The page does not state what the recommended configuration is for high throughput and low latency requirements.

Links

https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/custom-http/

AWS Go SDK V2 Module Versions Used

spss github.com/aws/aws-sdk-go@v1.54.2
spss github.com/aws/aws-sdk-go-v2@v1.28.0
spss github.com/aws/aws-sdk-go-v2/config@v1.27.18
spss github.com/aws/aws-sdk-go-v2/credentials@v1.17.18
spss github.com/aws/aws-sdk-go-v2/feature/ec2/imds@v1.16.5
spss github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.10
spss github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.10
spss github.com/aws/aws-sdk-go-v2/internal/ini@v1.8.0
spss github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8
spss github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2
spss github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery@v1.9.10
spss github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11
spss github.com/aws/aws-sdk-go-v2/service/kms@v1.33.1
spss github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11
spss github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5
spss github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12
spss github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go@v1.54.2 github.com/jmespath/go-jmespath@v0.4.0
github.com/aws/aws-sdk-go-v2@v1.28.0 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2@v1.28.0 github.com/jmespath/go-jmespath@v0.4.0
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/credentials@v1.17.18
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/feature/ec2/imds@v1.16.5
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/internal/ini@v1.8.0
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2
github.com/aws/aws-sdk-go-v2/config@v1.27.18 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/feature/ec2/imds@v1.16.5
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2
github.com/aws/aws-sdk-go-v2/credentials@v1.17.18 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11
github.com/aws/aws-sdk-go-v2/feature/ec2/imds@v1.16.5 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/feature/ec2/imds@v1.16.5 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.10 github.com/aws/aws-sdk-go-v2@v1.28.0
github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.10 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.10 github.com/aws/aws-sdk-go-v2@v1.28.0
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.10 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery@v1.9.10
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/dynamodb@v1.32.8 github.com/jmespath/go-jmespath@v0.4.0
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery@v1.9.10 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery@v1.9.10 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/kms@v1.33.1 github.com/aws/aws-sdk-go-v2@v1.28.0
github.com/aws/aws-sdk-go-v2/service/kms@v1.33.1 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.10
github.com/aws/aws-sdk-go-v2/service/kms@v1.33.1 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.10
github.com/aws/aws-sdk-go-v2/service/kms@v1.33.1 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/service/sso@v1.20.11 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/service/ssooidc@v1.24.5 github.com/aws/smithy-go@v1.20.2
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/aws-sdk-go-v2@v1.27.2
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/aws-sdk-go-v2/internal/configsources@v1.3.9
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/aws-sdk-go-v2/internal/endpoints/v2@v2.6.9
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding@v1.11.2
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/aws-sdk-go-v2/service/internal/presigned-url@v1.11.11
github.com/aws/aws-sdk-go-v2/service/sts@v1.28.12 github.com/aws/smithy-go@v1.20.2
lucix-aws commented 2 months ago

https://aws.github.io/aws-sdk-go-v2/docs/faq/#how-do-i-configure-my-sdks-http-client-are-there-any-guidelines-or-best-practices

At a minimum, we may want to forward this in the referenced developer guide section.

github-actions[bot] commented 2 months ago

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.