Skip to content

Fix logs exporter module name #3951

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.

Sign up for GitHub

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
jkwatson merged 5 commits into from
Dec 7, 2021
Merged

Fix logs exporter module name #3951

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e6cf5d
fix logs exporter module name
Dec 2, 2021
6a3574e
fix description
Dec 2, 2021
634544d
fix javadoc
Dec 2, 2021
2167784
fix spotlessJavaCheck
Dec 2, 2021
f5582a0
revert MarshalerLogsServiceGrpc
Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions exporters/otlp/logs/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ plugins {
id("org.unbroken-dome.test-sets")
}

description = "OpenTelemetry Protocol Trace Exporter"
otelJava.moduleName.set("io.opentelemetry.exporter.otlp.trace")
description = "OpenTelemetry Protocol Logs Exporter"
otelJava.moduleName.set("io.opentelemetry.exporter.otlp.logs")

testSets {
create("testGrpcNetty")
Expand Down
2 changes: 1 addition & 1 deletion ...otlp/logs/src/main/java/io/opentelemetry/exporter/otlp/logs/MarshalerLogsServiceGrpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import io.opentelemetry.exporter.otlp.internal.logs.LogsRequestMarshaler;
import java.io.InputStream;

// Adapted from the protoc generated code for LogsServiceGrpc.
/** Adapted from the protoc generated code for LogsServiceGrpc. */

@jkwatson jkwatson Dec 2, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think @anuraaga had deliberately not made this a Javadoc comment. Anuraag, can you confirm?

@anuraaga anuraaga Dec 2, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This isn't really javadoc so a comment it more appropriate. Let's revert this change

@jkwatson jkwatson Dec 3, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I realized my comment was in "pending status". 🤦🏽

@elevenzqx elevenzqx Dec 3, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, but I think this style is aligned with other source codes in project;
In addition, Javadoc single-line comment can not pass spotlessJavaCheck, just like this:

/**
 * Adapted from the protoc generated code for LogsServiceGrpc.
 */

Do I need revert this change or keep it, @anuraaga @jkwatson

@anuraaga anuraaga Dec 7, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In addition, Javadoc single-line comment can not pass spotlessJavaCheck, just like this:

I don't follow this - spotless is currently passing right? Let's go ahead and revert this - this is an internal class so it doesn't need real javadoc, this is an implementation detail comment targeted at code authors, not docs for end users. We like to make that distinction where possible.

@elevenzqx elevenzqx Dec 7, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I see, already revert

final class MarshalerLogsServiceGrpc {

private static final String SERVICE_NAME = "opentelemetry.proto.collector.logs.v1.LogsService";
Expand Down