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.

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

Jump to bottom

feat: implement query profile #1365

Merged
merged 19 commits into from
Mar 25, 2024
Merged

feat: implement query profile #1365

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
9d0a267
feat: query profiling
kolea2 Dec 13, 2023
b09775e
Merge branch 'main' of github.com:googleapis/java-datastore into qp
kolea2 Jan 4, 2024
c8b5ae3
Merge branch 'main' of github.com:googleapis/java-datastore into qp
kolea2 Jan 18, 2024
ca6a85e
fix clirr, run linter
kolea2 Jan 18, 2024
f23e1ec
review feedback
kolea2 Jan 18, 2024
151ce49
lint again
kolea2 Jan 18, 2024
4a6dc23
switch return type to optional for ResultSetStats
kolea2 Jan 18, 2024
31aa956
Merge branch 'main' of github.com:googleapis/java-datastore into qp
kolea2 Feb 13, 2024
d7bbb36
new api updates
kolea2 Feb 14, 2024
61f2e50
Merge branch 'main' of github.com:googleapis/java-datastore into qp
kolea2 Mar 9, 2024
058bc93
update clirr
kolea2 Mar 10, 2024
08d3563
Merge branch 'main' of github.com:googleapis/java-datastore into qp
kolea2 Mar 13, 2024
a439264
cleanup, add docs
kolea2 Mar 13, 2024
6c041b2
javadoc fixes
kolea2 Mar 13, 2024
12e1278
add betaapi in a few more places
kolea2 Mar 18, 2024
6d6a799
add some extra tests
kolea2 Mar 18, 2024
229fc25
add some more ITs
kolea2 Mar 18, 2024
9f34f34
add some more fine grained tests
kolea2 Mar 19, 2024
2e85328
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
add some more fine grained tests
  • Loading branch information
@kolea2
kolea2 committed Mar 19, 2024
commit 9f34f349ba8031e17fd6324fc7d9af6b1177bf16
9 changes: 4 additions & 5 deletions google-cloud-datastore/src/main/java/com/google/cloud/datastore/models/PlanSummary.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,19 @@
import com.google.api.core.InternalApi;
import com.google.cloud.Structs;
import com.google.common.base.Objects;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/** Model class for {@link com.google.datastore.v1.PlanSummary} */
@BetaApi
public class PlanSummary {
private final List<Map<String, Object>> indexesUsed = new ArrayList<>();
private final List<Map<String, Object>> indexesUsed;

@InternalApi
public PlanSummary(com.google.datastore.v1.PlanSummary proto) {
proto
.getIndexesUsedList()
.forEach(indexesUsed -> this.indexesUsed.add(Structs.asMap(indexesUsed)));
this.indexesUsed =
proto.getIndexesUsedList().stream().map(Structs::asMap).collect(Collectors.toList());
}

/** Returns the indexes selected for the query. */
Expand Down
23 changes: 15 additions & 8 deletions google-cloud-datastore/src/test/java/com/google/cloud/datastore/it/ITDatastoreTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ public void testQueryProfile() {
Truth.assertThat(results.hasNext()).isTrue();
Truth.assertThat(results.getExplainMetrics().isPresent()).isTrue();
assertPlanSummary(results.getExplainMetrics().get().getPlanSummary());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get(), 2, 2, "2");

QueryResults<Entity> results2 =
datastore.run(simpleOrQuery, ExplainOptions.newBuilder().build());
Expand All @@ -421,7 +421,8 @@ public void testQueryProfile() {
Truth.assertThat(resultsAggregation.size() > 0).isTrue();

assertPlanSummary(resultsAggregation.getExplainMetrics().get().getPlanSummary());
assertExecutionStats(resultsAggregation.getExplainMetrics().get().getExecutionStats().get());
assertExecutionStats(
resultsAggregation.getExplainMetrics().get().getExecutionStats().get(), 1, 1, "2");

AggregationQuery aggregationQuery2 =
Query.newAggregationQueryBuilder().over(simpleOrQuery).addAggregation(count()).build();
Expand Down Expand Up @@ -569,7 +570,7 @@ public void testTransactionExplainOptionsAnalyze() {

ExplainMetrics explainMetrics = baseResults.getExplainMetrics().get();
assertPlanSummary(explainMetrics.getPlanSummary());
assertExecutionStats(explainMetrics.getExecutionStats().get());
assertExecutionStats(explainMetrics.getExecutionStats().get(), 1, 1, "1");

baseTransaction.add(ENTITY3);
baseTransaction.commit();
Expand All @@ -585,7 +586,7 @@ public void testTransactionExplainOptionsAnalyze() {
assertTrue(results.size() > 0);

assertPlanSummary(results.getExplainMetrics().get().getPlanSummary());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get(), 1, 1, "1");
aggregationTransaction.commit();
}

Expand Down Expand Up @@ -625,19 +626,25 @@ private void assertPlanSummary(PlanSummary planSummary) {
each -> Truth.assertThat(each.keySet()).containsAtLeast("properties", "query_scope"));
}

private void assertExecutionStats(ExecutionStats executionStats) {
private void assertExecutionStats(
ExecutionStats executionStats,
long expectedReadOps,
long expectedResultsReturned,
String expectedIndexEntriesScanned) {
Map<String, Object> debugStats = executionStats.getDebugStats();
Truth.assertThat(debugStats.keySet())
.containsAtLeast("billing_details", "documents_scanned", "index_entries_scanned");
Truth.assertThat(debugStats.get("index_entries_scanned"))
.isEqualTo(expectedIndexEntriesScanned);

Duration executionDuration = executionStats.getExecutionDuration();
Truth.assertThat(executionDuration).isIn(Range.greaterThan(Duration.ofMillis(0)));

long readOperations = executionStats.getReadOperations();
Truth.assertThat(readOperations).isIn(Range.atLeast(1L));
Truth.assertThat(readOperations).isEqualTo(expectedReadOps);

long resultsReturned = executionStats.getResultsReturned();
Truth.assertThat(resultsReturned).isIn(Range.atLeast(1L));
Truth.assertThat(resultsReturned).isEqualTo(expectedResultsReturned);
}

@Test
Expand Down Expand Up @@ -1824,7 +1831,7 @@ private void testCountAggregationReadTimeWith(Consumer<AggregationQuery.Builder>
Long oldCount = getOnlyElement(results).getLong("total_count");
assertThat(oldCount).isEqualTo(2L);
assertPlanSummary(results.getExplainMetrics().get().getPlanSummary());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get());
assertExecutionStats(results.getExplainMetrics().get().getExecutionStats().get(), 1, 1, "2");
} finally {
datastore.delete(entity1.getKey(), entity2.getKey(), entity3.getKey());
}
Expand Down
2 changes: 2 additions & 0 deletions google-cloud-datastore/src/test/java/com/google/cloud/datastore/models/PlanSummaryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public class PlanSummaryTest {
private final Struct struct2 =
Struct.newBuilder()
.putFields("key2", Value.newBuilder().setStringValue("val2").build())
.putFields("key3", Value.newBuilder().setStringValue("val3").build())
.build();
private final com.google.datastore.v1.PlanSummary proto =
com.google.datastore.v1.PlanSummary.newBuilder()
Expand All @@ -43,6 +44,7 @@ public class PlanSummaryTest {
public void testModel() {
Truth.assertThat(planSummary.getIndexesUsed())
.isEqualTo(Lists.newArrayList(Structs.asMap(struct1), Structs.asMap(struct2)));
Truth.assertThat(planSummary.getIndexesUsed().get(0).get("key")).isEqualTo("val");
}

@Test
Expand Down