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

p[trace|metric|log]otlp.Response and p[trace|metric|log]otlp.Request do not follow naming convention #6365

Closed
bogdandrutu opened this issue Oct 20, 2022 · 6 comments · Fixed by #6370
Labels
bug Something isn't working

Comments

@bogdandrutu
Copy link
Member

Should they be named "Export[Logs|Metrics|Trace]ServiceRequest"?

/cc @dmitryax

@bogdandrutu bogdandrutu added the bug Something isn't working label Oct 20, 2022
@bogdandrutu
Copy link
Member Author

Another option is to drop the prefix Export[], if we do that we should remove it from Export[Logs|Metrics|Traces]PartialSuccess

@dmitryax
Copy link
Member

Export[Logs|Metrics|Trace]ServiceRequest maybe seemed like unnecessary long, so we potentially can add it to the exception list, but I think Export part is important enough to keep.

Given that these structs are used pretty rarely, I'd rather follow the guidelines here and apply the full name. WDYT?

@dmitryax
Copy link
Member

or maybe p[trace|metric|log]otlp.Export[Request|Response] and p[trace|metric|log]otlp.ExportPartialSuccess?

@bogdandrutu
Copy link
Member Author

I like the idea of dropping the data type from the name, since it is in the package name anyway. So I think we can add that as a guidance that, when the data type is in the name and does not provide value (like ResourceLogs) we should drop it.

So, we will have:

p[trace|metric|log]otlp.ExportService[Request|Response]
p[trace|metric|log]otlp.ExportPartialSuccess

@dmitryax
Copy link
Member

Makes sense, but I'm a bit unsure about ExportService[Request|Response] . It sounds a bit confusing comparing to Export[Request|Response]. Not sure why ExportMetricsServiceRequest message was introduced in proto, I believe it should be ExportRequest based on examples from https://developers.google.com/protocol-buffers/docs/proto3#services

@bogdandrutu
Copy link
Member Author

You should also post this on the proto repo. I think you are right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants