-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Completed port from v4. Unit tests pass locally. Next up: tests on cl…
…oud. (#9211)
- Loading branch information
David Noble
authored
Mar 24, 2020
1 parent
b580ccc
commit 72d66ac
Showing
22 changed files
with
1,413 additions
and
727 deletions.
There are no files selected for viewing
195 changes: 195 additions & 0 deletions
195
.../microsoft-azure-cosmos/src/main/java/com/azure/data/cosmos/internal/RequestTimeline.java
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 |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.data.cosmos.internal; | ||
|
|
||
| import com.azure.data.cosmos.internal.directconnectivity.rntbd.RntbdObjectMapper; | ||
| import com.fasterxml.jackson.annotation.JsonIgnore; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.fasterxml.jackson.annotation.JsonPropertyOrder; | ||
| import com.fasterxml.jackson.databind.annotation.JsonSerialize; | ||
| import com.fasterxml.jackson.databind.ser.std.ToStringSerializer; | ||
| import com.google.common.collect.ImmutableList; | ||
|
|
||
| import java.time.Duration; | ||
| import java.time.OffsetDateTime; | ||
| import java.util.Iterator; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
|
|
||
| /** | ||
| * Represents the startTime and duration of important events in the lifetime of a request. | ||
| * <p> | ||
| * A {@link RequestTimeline} represents a timeline as a sequence of {@link Event} instances with name, startTime, and | ||
| * duration properties. Hence, one might use this class to represent any timeline. Today we use it to represent | ||
| * request timelines for: | ||
| * <p><ul> | ||
| * <li>{@link com.azure.cosmos.implementation.http.HttpClient#send}, | ||
| * <li>{@link com.azure.cosmos.implementation.directconnectivity.HttpTransportClient#invokeStoreAsync}, and | ||
| * <li>{@link com.azure.cosmos.implementation.directconnectivity.RntbdTransportClient#invokeStoreAsync}. | ||
| * </ul></p> | ||
| * A {@link RequestTimeline} serializes to JSON as an array of {@link Event} instances. This is the default | ||
| * serialization for any class that implements {@link Iterable}. | ||
| * <p> | ||
| * <b>Example:</b> | ||
| * <pre>{@code OffsetDateTime startTime = OffsetDateTime.parse("2020-01-07T11:24:12.842749-08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME); | ||
| * sys.out.println(RequestTimeline.of( | ||
| * new RequestTimeline.Event("foo", startTime, startTime.plusSeconds(1)), | ||
| * new RequestTimeline.Event("bar", startTime.plusSeconds(1), startTime.plusSeconds(2))));}</pre> | ||
| * JSON serialization: | ||
| * <pre>{@code [{"name":"foo","startTime":"2020-01-07T11:24:12.842749-08:00","duration":"PT1S"},{"name":"bar","startTime":"2020-01-07T11:24:13.842749-08:00","duration":"PT1S"}])}</pre> | ||
| */ | ||
| public final class RequestTimeline implements Iterable<RequestTimeline.Event> { | ||
|
|
||
| private static final RequestTimeline EMPTY = new RequestTimeline(); | ||
| private final ImmutableList<Event> events; | ||
|
|
||
| private RequestTimeline() { | ||
| this.events = ImmutableList.of(); | ||
| } | ||
|
|
||
| private RequestTimeline(final ImmutableList<Event> events) { | ||
| checkNotNull(events, "expected non-null events"); | ||
| this.events = events; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an empty {@link RequestTimeline}. | ||
| * | ||
| * The empty startTime line returned is static. | ||
| * | ||
| * @return an empty {@link RequestTimeline}. | ||
| */ | ||
| public static RequestTimeline empty() { | ||
| return EMPTY; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an iterator for enumerating the {@link Event} instances in this {@link RequestTimeline}. | ||
| * | ||
| * @return an iterator for enumerating the {@link Event} instances in this {@link RequestTimeline}. | ||
| */ | ||
| @Override | ||
| public Iterator<Event> iterator() { | ||
| return this.events.iterator(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns an empty {@link RequestTimeline}. | ||
| * | ||
| * The empty startTime line returned is static and equivalent to calling {@link RequestTimeline#empty}. | ||
| * | ||
| * @return an empty request timeline. | ||
| */ | ||
| public static RequestTimeline of() { | ||
| return EMPTY; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with a single event. | ||
| * | ||
| * @return a new {@link RequestTimeline} with a single event. | ||
| */ | ||
| public static RequestTimeline of(final Event event) { | ||
| return new RequestTimeline(ImmutableList.of(event)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with a pair of events. | ||
| * | ||
| * @return a new {@link RequestTimeline} with a pair of events. | ||
| */ | ||
| public static RequestTimeline of(final Event e1, final Event e2) { | ||
| return new RequestTimeline(ImmutableList.of(e1, e2)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with three events. | ||
| * | ||
| * @return a new {@link RequestTimeline} with three events. | ||
| */ | ||
| public static RequestTimeline of(final Event e1, final Event e2, final Event e3) { | ||
| return new RequestTimeline(ImmutableList.of(e1, e2, e3)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with four events. | ||
| * | ||
| * @return a new {@link RequestTimeline} with four events. | ||
| */ | ||
| public static RequestTimeline of(final Event e1, final Event e2, final Event e3, final Event e4) { | ||
| return new RequestTimeline(ImmutableList.of(e1, e2, e3, e4)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with five events. | ||
| * | ||
| * @return a new {@link RequestTimeline} with five events. | ||
| */ | ||
| public static RequestTimeline of(final Event e1, final Event e2, final Event e3, final Event e4, final Event e5) { | ||
| return new RequestTimeline(ImmutableList.of(e1, e2, e3, e4, e5)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a new {@link RequestTimeline} with an arbitrary number of events. | ||
| * | ||
| * @return a new {@link RequestTimeline} with an arbitrary number of events. | ||
| */ | ||
| public static RequestTimeline of(final Event... events) { | ||
| return new RequestTimeline(ImmutableList.copyOf(events)); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a textual representation of this {@link RequestTimeline}. | ||
| * <p> | ||
| * The textual representation returned is a string of the form {@code RequestTimeline(}<i> <event-array></i> | ||
| * {@code )}. | ||
| */ | ||
| @Override | ||
| public String toString() { | ||
| return RntbdObjectMapper.toString(this); | ||
| } | ||
|
|
||
| @JsonPropertyOrder({ "name", "startTime", "durationInMicroSec" }) | ||
| public static final class Event { | ||
|
|
||
| @JsonIgnore | ||
| private final Duration duration; | ||
|
|
||
| @JsonSerialize(using = ToStringSerializer.class) | ||
| private final long durationInMicroSec; | ||
|
|
||
| @JsonProperty("eventName") | ||
| private final String name; | ||
|
|
||
| @JsonSerialize(using = ToStringSerializer.class) | ||
| private final OffsetDateTime startTime; | ||
|
|
||
| public Event(final String name, final OffsetDateTime from, final OffsetDateTime to) { | ||
|
|
||
| checkNotNull(name, "expected non-null name"); | ||
|
|
||
| this.name = name; | ||
| this.startTime = from; | ||
|
|
||
| this.duration = from == null ? null : to == null ? Duration.ZERO : Duration.between(from, to); | ||
| if(this.duration != null) { | ||
| this.durationInMicroSec = duration.toNanos()/1000L; | ||
| } else { | ||
| this.durationInMicroSec = 0; | ||
| } | ||
| } | ||
|
|
||
| public Duration getDuration() { | ||
| return this.duration; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public OffsetDateTime getStartTime() { | ||
| return startTime; | ||
| } | ||
| } | ||
| } |
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.