Skip to content

Commit 70502c3

Browse files
author
Liudmila Molkova
authored
KeyVault: new tracing (Azure#34172)
1 parent 1f896c4 commit 70502c3

File tree

16 files changed

+286
-286
lines changed

16 files changed

+286
-286
lines changed

‎sdk/keyvault/azure-security-keyvault-administration/src/main/java/com/azure/security/keyvault/administration/KeyVaultAccessControlAsyncClient.java‎

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333

3434
import static com.azure.core.util.FluxUtil.monoError;
3535
import static com.azure.core.util.FluxUtil.withContext;
36-
import static com.azure.core.util.tracing.Tracer.AZ_TRACING_NAMESPACE_KEY;
3736
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.validateRoleDefinitionParameters;
3837
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.validateRoleAssignmentParameters;
3938
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.validateAndGetRoleDefinitionCreateParameters;
@@ -62,10 +61,6 @@
6261
*/
6362
@ServiceClient(builder = KeyVaultAccessControlClientBuilder.class, isAsync = true)
6463
public final class KeyVaultAccessControlAsyncClient {
65-
// Please see <a href=https://docs.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers>here</a>
66-
// for more information on Azure resource provider namespaces.
67-
private static final String KEYVAULT_TRACING_NAMESPACE_VALUE = "Microsoft.KeyVault";
68-
6964
/**
7065
* The logger to be used.
7166
*/
@@ -200,7 +195,7 @@ Mono<PagedResponse<KeyVaultRoleDefinition>> listRoleDefinitionsFirstPage(String
200195

201196
return clientImpl.getRoleDefinitions()
202197
.listSinglePageAsync(vaultUrl, roleScope.toString(), null,
203-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
198+
context)
204199
.doOnRequest(ignored -> logger.verbose("Listing role definitions for roleScope - {}", roleScope))
205200
.doOnSuccess(response -> logger.verbose("Listed role definitions for roleScope - {}", roleScope))
206201
.doOnError(error -> logger.warning("Failed to list role definitions for roleScope - {}", roleScope,
@@ -229,8 +224,7 @@ Mono<PagedResponse<KeyVaultRoleDefinition>> listRoleDefinitionsFirstPage(String
229224
Mono<PagedResponse<KeyVaultRoleDefinition>> listRoleDefinitionsNextPage(String continuationToken, Context context) {
230225
try {
231226
return clientImpl.getRoleDefinitions()
232-
.listNextSinglePageAsync(continuationToken, vaultUrl, context.addData(AZ_TRACING_NAMESPACE_KEY,
233-
KEYVAULT_TRACING_NAMESPACE_VALUE))
227+
.listNextSinglePageAsync(continuationToken, vaultUrl, context)
234228
.doOnRequest(ignored ->
235229
logger.verbose("Listing next role definitions page - Page {}", continuationToken))
236230
.doOnSuccess(response ->
@@ -384,7 +378,7 @@ Mono<Response<KeyVaultRoleDefinition>> setRoleDefinitionWithResponse(SetRoleDefi
384378
return clientImpl.getRoleDefinitions()
385379
.createOrUpdateWithResponseAsync(vaultUrl, options.getRoleScope().toString(),
386380
options.getRoleDefinitionName(), parameters,
387-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
381+
context)
388382
.doOnRequest(ignored ->
389383
logger.verbose("Creating role definition - {}", options.getRoleDefinitionName()))
390384
.doOnSuccess(response -> logger.verbose("Created role definition - {}", response.getValue().getName()))
@@ -486,7 +480,7 @@ Mono<Response<KeyVaultRoleDefinition>> getRoleDefinitionWithResponse(KeyVaultRol
486480

487481
return clientImpl.getRoleDefinitions()
488482
.getWithResponseAsync(vaultUrl, roleScope.toString(), roleDefinitionName,
489-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
483+
context)
490484
.doOnRequest(ignored -> logger.verbose("Retrieving role definition - {}", roleDefinitionName))
491485
.doOnSuccess(response ->
492486
logger.verbose("Retrieved role definition - {}", response.getValue().getName()))
@@ -581,7 +575,7 @@ Mono<Response<Void>> deleteRoleDefinitionWithResponse(KeyVaultRoleScope roleScop
581575

582576
return clientImpl.getRoleDefinitions()
583577
.deleteWithResponseAsync(vaultUrl, roleScope.toString(), roleDefinitionName,
584-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
578+
context)
585579
.doOnRequest(ignored -> logger.verbose("Deleting role definition - {}", roleDefinitionName))
586580
.doOnSuccess(response -> logger.verbose("Deleted role definition - {}", response.getValue().getName()))
587581
.doOnError(error -> logger.warning("Failed to delete role definition - {}", roleDefinitionName, error))
@@ -656,7 +650,7 @@ Mono<PagedResponse<KeyVaultRoleAssignment>> listRoleAssignmentsFirstPage(String
656650

657651
return clientImpl.getRoleAssignments()
658652
.listForScopeSinglePageAsync(vaultUrl, roleScope.toString(), null,
659-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
653+
context)
660654
.doOnRequest(ignored -> logger.verbose("Listing role assignments for roleScope - {}", roleScope))
661655
.doOnSuccess(response -> logger.verbose("Listed role assignments for roleScope - {}", roleScope))
662656
.doOnError(error -> logger.warning("Failed to list role assignments for roleScope - {}", roleScope,
@@ -685,7 +679,7 @@ Mono<PagedResponse<KeyVaultRoleAssignment>> listRoleAssignmentsNextPage(String c
685679
try {
686680
return clientImpl.getRoleAssignments()
687681
.listForScopeNextSinglePageAsync(continuationToken, vaultUrl,
688-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
682+
context)
689683
.doOnRequest(ignored ->
690684
logger.verbose("Listing next role assignments page - Page {}", continuationToken))
691685
.doOnSuccess(response ->
@@ -850,7 +844,7 @@ Mono<Response<KeyVaultRoleAssignment>> createRoleAssignmentWithResponse(KeyVault
850844

851845
return clientImpl.getRoleAssignments()
852846
.createWithResponseAsync(vaultUrl, roleScope.toString(), roleAssignmentName, parameters,
853-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
847+
context)
854848
.doOnRequest(ignored -> logger.verbose("Creating role assignment - {}", roleAssignmentName))
855849
.doOnSuccess(response -> logger.verbose("Created role assignment - {}", response.getValue().getName()))
856850
.doOnError(error -> logger.warning("Failed to create role assignment - {}", roleAssignmentName, error))
@@ -947,7 +941,7 @@ Mono<Response<KeyVaultRoleAssignment>> getRoleAssignmentWithResponse(KeyVaultRol
947941
validateRoleAssignmentParameters(roleScope, roleAssignmentName);
948942
return clientImpl.getRoleAssignments()
949943
.getWithResponseAsync(vaultUrl, roleScope.toString(), roleAssignmentName,
950-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
944+
context)
951945
.doOnRequest(ignored -> logger.verbose("Retrieving role assignment - {}", roleAssignmentName))
952946
.doOnSuccess(response ->
953947
logger.verbose("Retrieved role assignment - {}", response.getValue().getName()))
@@ -1041,7 +1035,7 @@ Mono<Response<Void>> deleteRoleAssignmentWithResponse(KeyVaultRoleScope roleScop
10411035

10421036
return clientImpl.getRoleAssignments()
10431037
.deleteWithResponseAsync(vaultUrl, roleScope.toString(), roleAssignmentName,
1044-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE))
1038+
context)
10451039
.doOnRequest(ignored -> logger.verbose("Deleting role assignment - {}", roleAssignmentName))
10461040
.doOnSuccess(response -> logger.verbose("Deleted role assignment - {}", response.getValue().getName()))
10471041
.doOnError(error -> logger.warning("Failed to delete role assignment - {}", roleAssignmentName, error))

‎sdk/keyvault/azure-security-keyvault-administration/src/main/java/com/azure/security/keyvault/administration/KeyVaultAccessControlClient.java‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
import java.util.Objects;
3434
import java.util.UUID;
3535

36-
import static com.azure.core.util.tracing.Tracer.AZ_TRACING_NAMESPACE_KEY;
3736
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.enableSyncRestProxy;
3837
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.validateRoleDefinitionParameters;
3938
import static com.azure.security.keyvault.administration.KeyVaultAdministrationUtil.validateRoleAssignmentParameters;
@@ -65,7 +64,6 @@
6564
public final class KeyVaultAccessControlClient {
6665
// Please see <a href=https://docs.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers>here</a>
6766
// for more information on Azure resource provider namespaces.
68-
private static final String KEYVAULT_TRACING_NAMESPACE_VALUE = "Microsoft.KeyVault";
6967

7068
/**
7169
* The logger to be used.
@@ -207,7 +205,7 @@ PagedResponse<KeyVaultRoleDefinition> listRoleDefinitionsFirstPage(String vaultU
207205
try {
208206
PagedResponse<RoleDefinition> roleDefinitionPagedResponse = clientImpl.getRoleDefinitions()
209207
.listSinglePage(vaultUrl, roleScope.toString(), null,
210-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
208+
context);
211209
return KeyVaultAdministrationUtil.transformRoleDefinitionsPagedResponse(roleDefinitionPagedResponse);
212210
} catch (KeyVaultErrorException e) {
213211
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -233,8 +231,7 @@ PagedResponse<KeyVaultRoleDefinition> listRoleDefinitionsFirstPage(String vaultU
233231
PagedResponse<KeyVaultRoleDefinition> listRoleDefinitionsNextPage(String continuationToken, Context context) {
234232
try {
235233
PagedResponse<RoleDefinition> roleDefinitionPagedResponse = clientImpl.getRoleDefinitions()
236-
.listNextSinglePage(continuationToken, vaultUrl, context.addData(AZ_TRACING_NAMESPACE_KEY,
237-
KEYVAULT_TRACING_NAMESPACE_VALUE));
234+
.listNextSinglePage(continuationToken, vaultUrl, context);
238235
return KeyVaultAdministrationUtil.transformRoleDefinitionsPagedResponse(roleDefinitionPagedResponse);
239236
} catch (KeyVaultErrorException e) {
240237
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -367,7 +364,7 @@ public Response<KeyVaultRoleDefinition> setRoleDefinitionWithResponse(SetRoleDef
367364
Response<RoleDefinition> roleDefinitionResponse = clientImpl.getRoleDefinitions()
368365
.createOrUpdateWithResponse(vaultUrl, options.getRoleScope().toString(),
369366
options.getRoleDefinitionName(), parameters,
370-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
367+
context);
371368
return KeyVaultAdministrationUtil.transformRoleDefinitionResponse(roleDefinitionResponse);
372369
} catch (KeyVaultErrorException e) {
373370
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -447,7 +444,7 @@ public Response<KeyVaultRoleDefinition> getRoleDefinitionWithResponse(KeyVaultRo
447444
context = enableSyncRestProxy(context);
448445
Response<RoleDefinition> roleDefinitionResponse = clientImpl.getRoleDefinitions()
449446
.getWithResponse(vaultUrl, roleScope.toString(), roleDefinitionName,
450-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
447+
context);
451448
return KeyVaultAdministrationUtil.transformRoleDefinitionResponse(roleDefinitionResponse);
452449
} catch (KeyVaultErrorException e) {
453450
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -521,7 +518,7 @@ public Response<Void> deleteRoleDefinitionWithResponse(KeyVaultRoleScope roleSco
521518
context = enableSyncRestProxy(context);
522519
Response<RoleDefinition> roleDefinitionResponse = clientImpl.getRoleDefinitions()
523520
.deleteWithResponse(vaultUrl, roleScope.toString(), roleDefinitionName,
524-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
521+
context);
525522
return new SimpleResponse<>(roleDefinitionResponse, null);
526523

527524
} catch (KeyVaultErrorException e) {
@@ -620,7 +617,7 @@ PagedResponse<KeyVaultRoleAssignment> listRoleAssignmentsFirstPage(String vaultU
620617
try {
621618
PagedResponse<RoleAssignment> roleAssignmentPagedResponse = clientImpl.getRoleAssignments()
622619
.listForScopeSinglePage(vaultUrl, roleScope.toString(), null,
623-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
620+
context);
624621
return KeyVaultAdministrationUtil.transformRoleAssignmentsPagedResponse(roleAssignmentPagedResponse);
625622
} catch (KeyVaultErrorException e) {
626623
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -646,7 +643,7 @@ PagedResponse<KeyVaultRoleAssignment> listRoleAssignmentsNextPage(String continu
646643
try {
647644
PagedResponse<RoleAssignment> roleAssignmentPagedResponse = clientImpl.getRoleAssignments()
648645
.listForScopeNextSinglePage(continuationToken, vaultUrl,
649-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
646+
context);
650647
return KeyVaultAdministrationUtil.transformRoleAssignmentsPagedResponse(roleAssignmentPagedResponse);
651648
} catch (KeyVaultErrorException e) {
652649
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -785,7 +782,7 @@ public Response<KeyVaultRoleAssignment> createRoleAssignmentWithResponse(KeyVaul
785782
try {
786783
Response<RoleAssignment> roleAssignmentResponse = clientImpl.getRoleAssignments()
787784
.createWithResponse(vaultUrl, roleScope.toString(), roleAssignmentName, parameters,
788-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
785+
context);
789786
return KeyVaultAdministrationUtil.transformRoleAssignmentResponse(roleAssignmentResponse);
790787
} catch (KeyVaultErrorException e) {
791788
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -862,7 +859,7 @@ public Response<KeyVaultRoleAssignment> getRoleAssignmentWithResponse(KeyVaultRo
862859
context = enableSyncRestProxy(context);
863860
Response<RoleAssignment> roleAssignmentResponse = clientImpl.getRoleAssignments()
864861
.getWithResponse(vaultUrl, roleScope.toString(), roleAssignmentName,
865-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
862+
context);
866863
return KeyVaultAdministrationUtil.transformRoleAssignmentResponse(roleAssignmentResponse);
867864
} catch (KeyVaultErrorException e) {
868865
throw logger.logExceptionAsError(KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e));
@@ -934,7 +931,7 @@ public Response<Void> deleteRoleAssignmentWithResponse(KeyVaultRoleScope roleSco
934931
context = enableSyncRestProxy(context);
935932
Response<RoleAssignment> roleAssignmentResponse = clientImpl.getRoleAssignments()
936933
.deleteWithResponse(vaultUrl, roleScope.toString(), roleAssignmentName,
937-
context.addData(AZ_TRACING_NAMESPACE_KEY, KEYVAULT_TRACING_NAMESPACE_VALUE));
934+
context);
938935
return new SimpleResponse<>(roleAssignmentResponse, null);
939936
} catch (KeyVaultErrorException e) {
940937
KeyVaultAdministrationException mappedException = KeyVaultAdministrationUtils.toKeyVaultAdministrationException(e);

‎sdk/keyvault/azure-security-keyvault-administration/src/main/java/com/azure/security/keyvault/administration/KeyVaultAccessControlClientBuilder.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,12 @@
2727
import com.azure.core.util.Configuration;
2828
import com.azure.core.util.CoreUtils;
2929
import com.azure.core.util.HttpClientOptions;
30+
import com.azure.core.util.TracingOptions;
3031
import com.azure.core.util.builder.ClientBuilderUtil;
3132
import com.azure.core.util.logging.ClientLogger;
3233
import com.azure.core.util.ServiceVersion;
34+
import com.azure.core.util.tracing.Tracer;
35+
import com.azure.core.util.tracing.TracerProvider;
3336
import com.azure.security.keyvault.administration.implementation.KeyVaultCredentialPolicy;
3437
import com.azure.security.keyvault.administration.implementation.KeyVaultErrorCodeStrings;
3538

@@ -86,6 +89,10 @@ public final class KeyVaultAccessControlClientBuilder implements
8689
private final List<HttpPipelinePolicy> perRetryPolicies;
8790
private final Map<String, String> properties;
8891

92+
// Please see <a href=https://docs.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers>here</a>
93+
// for more information on Azure resource provider namespaces.
94+
private static final String KEYVAULT_TRACING_NAMESPACE_VALUE = "Microsoft.KeyVault";
95+
8996
private TokenCredential credential;
9097
private HttpPipeline pipeline;
9198
private URL vaultUrl;
@@ -212,9 +219,14 @@ private HttpPipeline getPipeline(Configuration buildConfiguration, ServiceVersio
212219
HttpPolicyProviders.addAfterRetryPolicies(policies);
213220
policies.add(new HttpLoggingPolicy(httpLogOptions));
214221

222+
TracingOptions tracingOptions = clientOptions == null ? null : clientOptions.getTracingOptions();
223+
Tracer tracer = TracerProvider.getDefaultProvider()
224+
.createTracer(clientName, clientVersion, KEYVAULT_TRACING_NAMESPACE_VALUE, tracingOptions);
225+
215226
return new HttpPipelineBuilder()
216227
.policies(policies.toArray(new HttpPipelinePolicy[0]))
217228
.httpClient(httpClient)
229+
.tracer(tracer)
218230
.build();
219231
}
220232

0 commit comments

Comments
 (0)