[eventhubs] - Upgrade Event Hubs to core-tracing preview.14 #20240

maorleger · 2022-02-07T22:32:28Z

Packages impacted by this PR

@azure/event-hubs
@azure/test-utils

Issues associated with this PR

#20213

Describe the problem that is addressed by this PR

Now that @azure/core-tracing@preview.14 is out, and hopefully the last version before GA, we need to upgrade a few packages in order to dogfood both the upgrade experience and the usage of these packages with the new instrumentation package.

My goal was to upgrade one AMQP package and a few HTTP packages in addition to core-rest-pipeline to collect feedback.

Upgrading EventHubs now allows us to start using the new APIs in a client package.

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

Haven't decided if this should be merged or if we should just publish to NPM under a custom tag in order to allow customers to dogfood. I know there's an internal IoT Hub engineer that is interested in helping out so we just need something for them to try.

Right now though I am leaning towards merging this in.

I also decided to dump all the parentSpan legacy stuff - there really isn't a need to maintain tracing backwards compat with an option that has not been used in over 6 months.

Are there test cases added in this PR? (If not, why?)

Lots and lots

Provide a list of related PRs (if any)

Command used to generate this PR:***(Applicable only to SDK release request PRs)*

Checklists

Added impacted package name to the issue description
Does this PR needs any fixes in the SDK Generator?** (If so, create an Issue in the Autorest/typescript repository and link it here)
Added a changelog (if necessary)
Create a follow-up issue with additional validations (ignoreDuplicateSpanNames, expectedSpanAttributes, expectedSpanKind, etc)

check-enforcer · 2022-02-07T22:43:01Z

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 js - [service] - ci

azure-sdk · 2022-02-08T02:12:39Z

API changes have been detected in @azure/event-hubs. You can review API changes here

API changes

-     parentSpan?: Span | SpanContext;

azure-sdk · 2022-02-09T00:20:26Z

API changes have been detected in @azure/core-amqp. You can review API changes here

API changes

+     readonly messageState: "x-opt-message-state";

azure-sdk · 2022-02-09T00:20:29Z

API changes have been detected in @azure/core-auth. You can review API changes here

azure-sdk · 2022-02-09T00:20:31Z

API changes have been detected in @azure/core-client. You can review API changes here

API changes

+ export interface AdditionalPolicyConfig {
+     policy: PipelinePolicy;
+     position: "perCall" | "perRetry";
+ }
+ export declare function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>;
+     additionalPolicies?: AdditionalPolicyConfig[];
- export declare type RawResponseCallback = (rawResponse: FullOperationResponse, flatResponse: unknown) => void;
+ export declare type RawResponseCallback = (rawResponse: FullOperationResponse, flatResponse: unknown, error?: unknown) => void;

azure-sdk · 2022-02-09T00:20:39Z

API changes have been detected in @azure/core-http. You can review API changes here

azure-sdk · 2022-02-09T00:20:41Z

API changes have been detected in @azure/core-rest-pipeline. You can review API changes here

azure-sdk · 2022-02-09T00:20:44Z

API changes have been detected in @azure/core-lro. You can review API changes here

maorleger · 2022-02-09T00:45:05Z

Check enforcer isn't being updated but here's the build: https://dev.azure.com/azure-sdk/public/_build/results?buildId=1353756&view=results

And the live test run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1353821&view=results

maorleger · 2022-02-09T00:45:15Z

/azp run js - event-hubs - tests

azure-pipelines · 2022-02-09T00:45:29Z

Azure Pipelines successfully started running 1 pipeline(s).

maorleger · 2022-02-09T00:48:49Z

sdk/eventhub/event-hubs/src/diagnostics/tracing.ts

- *
- * @internal
- */
-export function convertTryAddOptionsForCompatibility(tryAddOptions: TryAddOptions): TryAddOptions {


What this does if I understand it correctly is that it supports a few obsolete span parenting options.

In general our policy has been that it's unnecessary to keep backwards compat for tracing options, which is what this function does, at least while tracing is in preview. parentSpan hasn't been a thing in quite some time, neither has spanOptions, and we rely exclusively on tracingContext throughout our code. I think it's safe to file this away but if you strongly disagree let me know

sdk/eventhub/event-hubs/src/eventDataBatch.ts

sdk/eventhub/event-hubs/test/public/node/client.spec.ts

xirzec

I like the changes here! My only dream (if it's not too messy) is a way to trim the Spans off the public shape of batch so we don't need to enforce them.

sdk/eventhub/event-hubs/certs/my-private-root-ca.crt.srl

xirzec

Whoops I didn't see that _messageSpanContexts got removed here: 6b7e478

So I'm good now!

sdk/eventhub/event-hubs/package.json

sdk/eventhub/event-hubs/review/event-hubs.api.md

sdk/eventhub/event-hubs/src/partitionPump.ts

sdk/eventhub/event-hubs/test/internal/misc.spec.ts

HarshaNalluru

Looks good overall. 🎉
Just asking a few questions/doubts, might be dumb, asking anyway. 😎

ramya-rao-a · 2022-02-14T22:23:26Z

Can we have a changelog entry please?

sdk/eventhub/event-hubs/src/eventHubProducerClient.ts

sdk/eventhub/event-hubs/test/internal/sender.spec.ts

jeremymeng

Looks good to me. Thanks for the simplified testing!

maorleger · 2022-02-15T01:08:27Z

Can we have a changelog entry please?

Added - would love some feedback if there's changes I should make

### Packages impacted by this PR @azure/data-tables ### Issues associated with this PR - #20213 - #5607 ### Describe the problem that is addressed by this PR Now that @azure/core-tracing@preview.14 is out, and hopefully the last version before GA, we need to upgrade a few packages in order to dogfood both the upgrade experience and the usage of these packages with the new instrumentation package. My goal was to upgrade one AMQP package and a few HTTP packages in addition to core-rest-pipeline to collect feedback. Upgrading Data Tables now allows us to start using the new APIs in a client package. ### Provide a list of related PRs _(if any)_ - #20240

ghost added the Event Hubs label Feb 7, 2022

maorleger force-pushed the upgrade-eventhubs branch from 091b4ab to 41702c0 Compare February 8, 2022 02:01

maorleger force-pushed the upgrade-eventhubs branch from 026e10f to e12d078 Compare February 8, 2022 22:47

maorleger force-pushed the upgrade-eventhubs branch from 191e6e0 to 1ec1f3f Compare February 9, 2022 00:27

maorleger marked this pull request as ready for review February 9, 2022 00:38

maorleger requested review from bterlson, deyaaeldeen, HarshaNalluru, jeremymeng, mikeharder, praveenkuttappan, ramya-rao-a, sadasant, timovv, witemple-msft and xirzec as code owners February 9, 2022 00:38

maorleger requested a review from richardpark-msft February 9, 2022 00:38

maorleger changed the title ~~Upgrade eventhubs~~ [eventhubs] - Upgrade Event Hubs to core-tracing preview.14 Feb 9, 2022

maorleger commented Feb 9, 2022

View reviewed changes

xirzec reviewed Feb 9, 2022

View reviewed changes

maorleger commented Feb 9, 2022

View reviewed changes

sdk/eventhub/event-hubs/certs/my-private-root-ca.crt.srl Outdated Show resolved Hide resolved

xirzec approved these changes Feb 9, 2022

View reviewed changes

maorleger force-pushed the upgrade-eventhubs branch from d0b856b to ce48e0d Compare February 10, 2022 20:29