-
Notifications
You must be signed in to change notification settings - Fork 858
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
Refactor Event API to reflect spec changes #6318
Merged
jack-berg
merged 2 commits into
open-telemetry:main
from
jack-berg:event-payload-log-body
Mar 29, 2024
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,28 +5,107 @@ | |
|
||
package io.opentelemetry.api.incubator.events; | ||
|
||
import io.opentelemetry.api.common.Attributes; | ||
import io.opentelemetry.api.incubator.logs.AnyValue; | ||
import io.opentelemetry.api.logs.Severity; | ||
import io.opentelemetry.context.Context; | ||
import java.time.Instant; | ||
import java.util.ArrayList; | ||
import java.util.List; | ||
import java.util.concurrent.TimeUnit; | ||
|
||
/** The EventBuilder is used to {@link #emit()} events. */ | ||
public interface EventBuilder { | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, String value) { | ||
return put(key, AnyValue.of(value)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, long value) { | ||
return put(key, AnyValue.of(value)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, double value) { | ||
return put(key, AnyValue.of(value)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, boolean value) { | ||
return put(key, AnyValue.of(value)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, String... value) { | ||
List<AnyValue<?>> values = new ArrayList<>(value.length); | ||
for (String val : value) { | ||
values.add(AnyValue.of(val)); | ||
} | ||
return put(key, AnyValue.of(values)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, long... value) { | ||
List<AnyValue<?>> values = new ArrayList<>(value.length); | ||
for (long val : value) { | ||
values.add(AnyValue.of(val)); | ||
} | ||
return put(key, AnyValue.of(values)); | ||
breedx-splk marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, double... value) { | ||
List<AnyValue<?>> values = new ArrayList<>(value.length); | ||
for (double val : value) { | ||
values.add(AnyValue.of(val)); | ||
} | ||
return put(key, AnyValue.of(values)); | ||
} | ||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
default EventBuilder put(String key, boolean... value) { | ||
List<AnyValue<?>> values = new ArrayList<>(value.length); | ||
for (boolean val : value) { | ||
values.add(AnyValue.of(val)); | ||
} | ||
return put(key, AnyValue.of(values)); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The test coverage on these default methods comes from the SDK. Do we care about having direct coverage from the API itself? |
||
|
||
/** Put the given {@code key} and {@code value} in the payload. */ | ||
EventBuilder put(String key, AnyValue<?> value); | ||
|
||
/** | ||
* Set the epoch {@code timestamp} for the event, using the timestamp and unit. | ||
* Set the epoch {@code timestamp}, using the timestamp and unit. | ||
* | ||
* <p>The {@code timestamp} is the time at which the event occurred. If unset, it will be set to | ||
* the current time when {@link #emit()} is called. | ||
*/ | ||
EventBuilder setTimestamp(long timestamp, TimeUnit unit); | ||
|
||
/** | ||
* Set the epoch {@code timestamp} for the event, using the instant. | ||
* Set the epoch {@code timestamp}, using the instant. | ||
* | ||
* <p>The {@code timestamp} is the time at which the event occurred. If unset, it will be set to | ||
* the current time when {@link #emit()} is called. | ||
*/ | ||
EventBuilder setTimestamp(Instant instant); | ||
|
||
/** Set the context. */ | ||
EventBuilder setContext(Context context); | ||
|
||
/** Set the severity. */ | ||
EventBuilder setSeverity(Severity severity); | ||
|
||
/** | ||
* Set the attributes. | ||
* | ||
* <p>Event {@link io.opentelemetry.api.common.Attributes} provide additional details about the | ||
* Event which are not part of the well-defined {@link AnyValue} {@code payload}. | ||
*/ | ||
EventBuilder setAttributes(Attributes attributes); | ||
|
||
/** Emit an event. */ | ||
void emit(); | ||
} |
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's fine for now, but removing this requires the user wanting to use the "empty" event (where there is no payload, which spec allows) to do
eventLogger.builder("foo").build()
which is fine, but could have improved ergonomics in the future. 👍🏻I also respect that we're sensitive to API surface area. 🙃