Skip to content

Add metrics emitted from BulkExecutor responsible for dynamic batch size tuning. #43716

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
jeet1995 merged 10 commits into from
Jan 9, 2025
Merged

Add metrics emitted from BulkExecutor responsible for dynamic batch size tuning. #43716

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9a621a0
Comment out failing tests.
jeet1995 Dec 18, 2024
d508f8d
Merge branch 'main' of github.com:jeet1995/azure-sdk-for-java into Bu…
jeet1995 Jan 6, 2025
62ca496
Adding javadoc.
jeet1995 Dec 18, 2024
cbdec3d
Adding targetMaxMicroBatchSize as client telemetry metric.
jeet1995 Dec 18, 2024
ec620ab
Remove unnecessary public API from `CosmosBatchResponse`.
jeet1995 Jan 7, 2025
7ec7824
Remove unnecessary public API from `CosmosBatchResponse`.
jeet1995 Jan 7, 2025
7b34d01
Added javadoc and modified CHANGELOG.md
jeet1995 Jan 7, 2025
f26ab51
Added javadoc.
jeet1995 Jan 7, 2025
a3ea8c7
Fix tests.
jeet1995 Jan 8, 2025
c27114d
Document new metrics in Metrics.md
jeet1995 Jan 9, 2025
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
Prev Previous commit
Next Next commit
Added javadoc and modified CHANGELOG.md
  • Loading branch information
@jeet1995
jeet1995 committed Jan 7, 2025
commit 7b34d01778db1f9bfe7db4b8cdba28696dbecf2b
9 changes: 9 additions & 0 deletions sdk/cosmos/azure-cosmos/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@
* Added support to allow changing http2 max connection pool size with system property `COSMOS.HTTP2_MAX_CONNECTION_POOL_SIZE` and system variable `COSMOS_HTTP2_MAX_CONNECTION_POOL_SIZE`. - [PR 42947](https://github.com/Azure/azure-sdk-for-java/pull/42947)
* Added support to allow changing http2 max connection pool size with system property `COSMOS.HTTP2_MIN_CONNECTION_POOL_SIZE` and system variable `COSMOS_HTTP2_MIN_CONNECTION_POOL_SIZE`. - [PR 42947](https://github.com/Azure/azure-sdk-for-java/pull/42947)
* Added options to fine-tune settings for bulk operations. - [PR 43509](https://github.com/Azure/azure-sdk-for-java/pull/43509)
* Added the following metrics. - See [PR 43716](https://github.com/Azure/azure-sdk-for-java/pull/43716)
*`cosmos.req.gw.bulkOpCountPerEvaluation`
*`cosmos.req.gw.bulkOpRetriedCountPerEvaluation`
*`cosmos.req.gw.bulkGlobalOpCount`
*`cosmos.req.gw.bulkTargetMaxMicroBatchSize`
*`cosmos.req.rntbd.bulkOpCountPerEvaluation`
*`cosmos.req.rntbd.bulkOpRetriedCountPerEvaluation`
*`cosmos.req.rntbd.bulkGlobalOpCount`
*`cosmos.req.rntbd.bulkTargetMaxMicroBatchSize`

### 4.65.0 (2024-11-19)

Expand Down
54 changes: 42 additions & 12 deletions sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosMetricName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,34 +113,42 @@ private CosmosMetricName(String name, CosmosMetricCategory metricCategory) {
public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_ACTUAL_ITEM_COUNT = new CosmosMetricName(
nameOf("req.rntbd.actualItemCount"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* Op count per evaluation - relevant for batch operations executed by bulk executor
* NOTE: No percentiles or histogram supported
*/
* The count of batch operations per evaluation cycle per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* In every evaluation cycle the no. of items to touch per batch I/O operation is computed to reasonably saturate provisioned throughput without getting throttled.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_BULK_OP_COUNT_PER_EVALUATION = new CosmosMetricName(
nameOf("req.rntbd.bulkOpCountPerEvaluation"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* Op retried count per evaluation - relevant for batch operations executed by bulk executor
* NOTE: No percentiles or histogram supported
*/
* The count of batch operations retried per evaluation cycle per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* In every evaluation cycle the no. of items to touch per batch I/O operation is computed to reasonably saturate provisioned throughput without getting throttled.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_BULK_OP_RETRIED_COUNT_PER_EVALUATION = new CosmosMetricName(
nameOf("req.rntbd.bulkOpRetriedCountPerEvaluation"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* Global op count - relevant for batch operations executed by bulk executor
* NOTE: No percentiles or histogram supported
*/
* The count of batch operations per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_BULK_GLOBAL_OP_COUNT = new CosmosMetricName(
nameOf("req.rntbd.bulkGlobalOpCount"),
CosmosMetricCategory.REQUEST_SUMMARY);


/**
* Target max micro batch size - relevant for batch operations executed by bulk executor
* NOTE: No percentiles or histogram supported
*/
* The max count of items to touch per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_BULK_TARGET_MAX_MICRO_BATCH_SIZE = new CosmosMetricName(
nameOf("req.rntbd.bulkTargetMaxMicroBatchSize"),
CosmosMetricCategory.REQUEST_SUMMARY);
Expand Down Expand Up @@ -176,18 +184,40 @@ private CosmosMetricName(String name, CosmosMetricCategory metricCategory) {
nameOf("req.gw.actualItemCount"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* The count of batch operations per evaluation cycle per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* In every evaluation cycle the no. of items to touch per batch I/O operation is computed to reasonably saturate provisioned throughput without getting throttled.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_BULK_OP_COUNT_PER_EVALUATION = new CosmosMetricName(
nameOf("req.gw.bulkOpCountPerEvaluation"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* The count of batch operations retried per evaluation cycle per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* In every evaluation cycle the no. of items to touch per batch I/O operation is computed to reasonably saturate provisioned throughput without getting throttled.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_BULK_OP_RETRIED_COUNT_PER_EVALUATION = new CosmosMetricName(
nameOf("req.gw.bulkOpRetriedCountPerEvaluation"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* The count of batch operations per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_BULK_GLOBAL_OP_COUNT = new CosmosMetricName(
nameOf("req.gw.bulkGlobalOpCount"),
CosmosMetricCategory.REQUEST_SUMMARY);

/**
* The max count of items to touch per physical partition executed through {@link com.azure.cosmos.CosmosContainer#executeBulkOperations} or {@link com.azure.cosmos.CosmosAsyncContainer#executeBulkOperations}.
* <p>
* NOTE: No percentiles or histogram supported.
* */
public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_BULK_TARGET_MAX_MICRO_BATCH_SIZE = new CosmosMetricName(
nameOf("req.gw.bulkTargetMaxMicroBatchSize"),
CosmosMetricCategory.REQUEST_SUMMARY);
Expand Down
Loading