Allowing CorrelationActivityId to be sent to BE and retrieved from FeedResponse

[FabianMeiswinkel]

Description

Adds an (internal) API to specify a CorrelationActviityId in CosmosQueryRequestOptions - if not set a new UUID will be generated for each query. This CorrelationActivityId is sent to the backend (and used in Kusto logs for SqlQueryExecMetrics) to allow correlating client-logs with service telemetry. The FeedResponse has a new public property that allows retrieving the CorrelationActivityId for document query responses.

This PR also wires up the correlation activity id with the Spark connector.

Important design aspects

The Api to allow specifying a custom correlation activity Id in CosmosQueryRequestOptions is currently internal - not public - to avoid cases where customers accidentally or intentionally force the same constant UUID value for all query requests - this would result in losing ability to correlate service telemetry. So, this option is only used in Spark where we use the concept of a correlation Id across multiple different operations already within the Spark layer.

Other customers can get the correlationId generated per query from the FeedResponse

All SDK Contribution checklist:

• The pull request does not introduce [breaking changes]
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• I have read the contribution guidelines.

General Guidelines and Best Practices

• Title of the pull request is clear and informative.
• There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• Pull request includes test coverage for the included changes.

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

[azure-sdk]

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

API changes

+         public UUID getCorrelationActivityId() 

[xinlian12]

LGTM, thanks

[FabianMeiswinkel]

/azp run java - cosmos - spark

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[FabianMeiswinkel]

/azp run java - cosmos - tests

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[FabianMeiswinkel]

/azp run java - cosmos - spark

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[azure-sdk]

API changes have been detected in com.azure:azure-cosmos. You can review API changes here

API changes

-         public CosmosBulkExecutionOptions(CosmosBulkExecutionThresholdsState thresholdsState, Map<String, String> customOptions) 
+         public UUID getCorrelationActivityId() 

[FabianMeiswinkel]

/azp run java - cosmos - spark

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).