Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Semantic convention around retry attempts? #1306

Open
toumorokoshi opened this issue Dec 26, 2020 · 3 comments
Open

Semantic convention around retry attempts? #1306

toumorokoshi opened this issue Dec 26, 2020 · 3 comments
Labels
area:semantic-conventions Related to semantic conventions priority:p3 Lowest priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:trace Related to the specification/trace directory

Comments

@toumorokoshi
Copy link
Member

What are you trying to achieve?

Propose a convention around retry count, if one does not exist already.

What did you expect to see?

A semantic convention around retry attempts. Motivated by open-telemetry/opentelemetry-python-contrib#275 (comment).

As a proposal:

  • field name: retry_count
  • value: integer
  • description: the attempt number of retries for this particular request. 0 implies this is the first try, while 1 implies it is the first retry.
@toumorokoshi toumorokoshi added the spec:trace Related to the specification/trace directory label Dec 26, 2020
@anuraaga
Copy link
Contributor

Having a retry convention would be great. One thing to compare against is using events to model retries to include timing. Just a count itself is pretty useful but this could be more complete and even more useful.

@carlosalberto carlosalberto added area:semantic-conventions Related to semantic conventions priority:p3 Lowest priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs labels Jan 4, 2021
@pc-alves
Copy link

pc-alves commented May 2, 2021

In the past I have used a combination of a Span Tag and Span Log:

  • retry | bool | When present on a client span, they represent a span that wraps a retried RPC. If missing no interpretation can be made. An explicit value of false would explicitly mean it is a first RPC attempt.
  • retry_number | integer | In combination with retry tag, this field holds the number of the retry attempt
    • (this one was set as a Span Log)

This allowed querying for retried calls, and knowing how many retries were done.

@aaron-ai
Copy link
Member

aaron-ai commented Sep 2, 2021

'attempt' or 'attempt_times' may be better, 'retry_count' is ambiguous in my opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions priority:p3 Lowest priority level release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:trace Related to the specification/trace directory
Projects
None yet
Development

No branches or pull requests

5 participants