Skip to content

[CSHARP-969] - OpenTelemetry tracing RFC #603

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

Merged
merged 7 commits into from
Mar 13, 2024

Conversation

simaoribeiro
Copy link
Contributor

As discussed in https://datastax-oss.atlassian.net/browse/CSHARP-969?focusedCommentId=55554, this document describes a proposal for the inclusion of tracing for C# driver that follows the OpenTelemetry specification.

It was based on the template available in the Rust lang repository and should be used as a support guide for the reading of the proposal
https://github.com/rust-lang/rfcs/blob/master/0000-template.md

In the repository below, there is an incomplete POC developed by our team that can be viewed when analyzing the technical parts of the proposal:
simaoribeiro#2

@joao-r-reis
Copy link
Collaborator

Hi, sorry for the delay. Now that the 3.20.0 release is out I can take a look at this.

@simaoribeiro
Copy link
Contributor Author

Hi, sorry for the delay. Now that the 3.20.0 release is out I can take a look at this.

Thank you @joao-r-reis

Copy link
Collaborator

@joao-r-reis joao-r-reis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for the detailed proposal, this can serve as a model for future contributions of a similar (or larger) scale 😄

I added my comments on it but overall I agree with the core idea behind the proposal 👍

I have some concerns on how the proposed API can be extended to provide node level tracing in the future (for retries and speculative executions) but we can have that discussion in the relevant comment below.

@simaoribeiro
Copy link
Contributor Author

Hi @joao-r-reis . I've been busy in the last couple of weeks but I will focus this PR again starting tomorrow.

@joao-r-reis
Copy link
Collaborator

Hi @joao-r-reis . I've been busy in the last couple of weeks but I will focus this PR again starting tomorrow.

Sounds good! No worries.

This document describes a proposal for the inclusion of tracing for
C# driver that follows the OpenTelemetry specification.

Co-authored-by: Ailton Silva <ailton.silva@farfetch.com>
Co-authored-by: Rui Quintas Barbosa <rui.quintasbarbosa@farfetch.com>

Reviewed-by: Bruno Dutra <bruno.dutra@farfetch.com>
Reviewed-by: João Pereira Rodrigues <j.rodrigues@farfetch.com>
Reviewed-by: Joel Oliveira <joel.oliveira@farfetch.com>
Reviewed-by: Luis Couto <luis.couto@farfetch.com>
@simaoribeiro simaoribeiro force-pushed the docs/open-telemetry-rfc branch from 70c095d to 28d8636 Compare March 7, 2024 15:08
@joao-r-reis
Copy link
Collaborator

Can you move the files on this PR to a separate folder called proposals at the root of the repo? We don't really want to include this proposal in the driver docs that are published to https://docs.datastax.com/en/developer/csharp-driver/ as this proposal is meant more for contributors of the project while those driver docs are meant for users.

We will later need documentation for users but we'll worry about that after the feature is done.

Co-authored-by: Ailton Pinto <ailtonguitar@hotmail.com>
@simaoribeiro
Copy link
Contributor Author

@joao-r-reis Done. Do you want me to squash the commits and rebase?

@joao-r-reis
Copy link
Collaborator

@joao-r-reis Done. Do you want me to squash the commits and rebase?

No need, I always squash and merge on this repo.

@joao-r-reis
Copy link
Collaborator

Before I can merge this PR I need you guys to sign the CLA: https://cla.datastax.com/

I see that there are 2 co-authors:

Co-authored-by: Ailton Silva <ailton.silva@farfetch.com>
Co-authored-by: Rui Quintas Barbosa <rui.quintasbarbosa@farfetch.com> 

@simaoribeiro
Copy link
Contributor Author

Hi @joao-r-reis , I think all the CLAs are signed.
Just a question: my CLA was signed used, by mistake, my personal email as it was the primary e-mail associated with my github account. However, the rest of the fields (including Company and GitHub Username) are correct. Do you think there is any problem? I can send a second one with the correct e-mail

@joao-r-reis
Copy link
Collaborator

Hi @joao-r-reis , I think all the CLAs are signed. Just a question: my CLA was signed used, by mistake, my personal email as it was the primary e-mail associated with my github account. However, the rest of the fields (including Company and GitHub Username) are correct. Do you think there is any problem? I can send a second one with the correct e-mail

Yeah please send a second one with the correct e-mail 👍

@simaoribeiro
Copy link
Contributor Author

Hi @joao-r-reis , I sent an email to cla@datastax.com with the correct document signed (as it looks like the GitHub integration doesn't allow edits for a given GitHub account).

I believe everything is fine now

@joao-r-reis
Copy link
Collaborator

Thanks, I'm going to merge this 👍

@simaoribeiro
Copy link
Contributor Author

Alright, I expect to be working on the implementation by next week

@joao-r-reis joao-r-reis merged commit c004fcb into datastax:master Mar 13, 2024
@joao-r-reis
Copy link
Collaborator

Related PRs:

#608
#612
#613
#614

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants