Describe falling back to string mangling for AWS SDK RPC specifiers. #1851
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
anuraaga
force-pushed
the
aws-sdk-fallback
branch
from
8168036
to
c548013
Compare
Oberon00
reviewed
Aug 5, 2021
| @@ -16,12 +16,19 @@ groups: | |||
| examples: | |||
| - aws-api | |||
| - ref: rpc.service | |||
| brief: "The name of the service to which a request is made, as returned by the AWS SDK." | |||
| brief: > | |||
| The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not | |||
There was a problem hiding this comment.
Consider moving part of this to the note.
Also I would like to have (in the note) a more fully described example that states the "input" client interface name in addition to the resulting value.
Same for rpc.method.
There was a problem hiding this comment.
Thanks, it seems to have fixed a bad note that was there too
carlosalberto
approved these changes
Aug 5, 2021
added 2 commits
August 10, 2021 13:32
…ication into aws-sdk-fallback
Oberon00
reviewed
Aug 10, 2021
| note: > | ||
| If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a | ||
| service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with | ||
| no spaces. For example, `DynamoDBClient` would be `DynamoDB`. |
There was a problem hiding this comment.
Suggested change
| no spaces. For example, `DynamoDBClient` would be `DynamoDB`. | |
| no spaces. For example, `DynamoDBClient` would become `DynamoDB`. |
| note: > | ||
| If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, | ||
| removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. For example, | ||
| `GetItemCommand` would be `GetItem`. |
There was a problem hiding this comment.
Suggested change
| `GetItemCommand` would be `GetItem`. | |
| `getItemCommand` would become `getItem`. |
Is that correct? Or do we want case normalization too?
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
Not all AWS SDKs provide a way to access the service and operation names of an AWS API. We will work internally to ensure at least newer ones do, the models themselves that define AWS APIs include the data in the form of cloudFormationName.
In the meantime, we should allow instrumentation to generate a reasonable based on what it's got.
Related issues aspecto-io/opentelemetry-ext-js#160