[KeyVault] Add logPolicy to KeyVault library pipeline configurations (#…

…5605) * Add logPolicy configuration to @azure/keyvault-certificates * Add logPolicy configuration to @azure/keyvault-keys * Add logPolicy configuration to @azure/keyvault-secrets * Add logPolicy to cryptographyClient in keyvault-keys * api-version is now in the default allowed query param list
AzureSDKAutomation · Oct 21, 2019 · 04defe7 · 04defe7
1 parent 7e23aab
commit 04defe7
Show file tree

Hide file tree

Showing 13 changed files with 96 additions and 13 deletions.
diff --git a/sdk/keyvault/keyvault-certificates/package.json b/sdk/keyvault/keyvault-certificates/package.json
@@ -72,6 +72,7 @@
     "@azure/core-http": "1.0.0-preview.6",
     "@azure/core-paging": "1.0.0-preview.2",
     "@azure/core-tracing": "1.0.0-preview.5",
+    "@azure/logger": "1.0.0-preview.1",
     "tslib": "^1.9.3"
   },
   "devDependencies": {

diff --git a/sdk/keyvault/keyvault-certificates/review/keyvault-certificates.api.md b/sdk/keyvault/keyvault-certificates/review/keyvault-certificates.api.md
@@ -219,6 +219,9 @@ export interface LifetimeAction {
     trigger?: Trigger;
 }
 
+// @public
+export const logger: import("@azure/logger").AzureLogger;
+
 // @public
 export interface NewPipelineOptions {
     // (undocumented)

diff --git a/sdk/keyvault/keyvault-certificates/src/index.ts b/sdk/keyvault/keyvault-certificates/src/index.ts
@@ -15,10 +15,12 @@ import {
   isNode,
   userAgentPolicy,
   RequestOptionsBase,
-  tracingPolicy
+  tracingPolicy,
+  logPolicy
 } from "@azure/core-http";
 
 import { getTracer, Span } from "@azure/core-tracing";
+import { logger } from "./log";
 
 import {
   Certificate,
@@ -119,7 +121,8 @@ export {
   OrganizationDetails,
   ParsedKeyVaultEntityIdentifier,
   SecretProperties,
-  X509CertificateProperties
+  X509CertificateProperties,
+  logger
 };
 
 export { ProxyOptions, RetryOptions, TelemetryOptions };
@@ -253,7 +256,15 @@ export class CertificateClient {
       redirectPolicy(),
       isTokenCredential(credential)
         ? challengeBasedAuthenticationPolicy(credential)
-        : signingPolicy(credential)
+        : signingPolicy(credential),
+      logPolicy(
+        logger.info, {
+          allowedHeaderNames: [
+            "x-ms-keyvault-region",
+            "x-ms-keyvault-network-info",
+            "x-ms-keyvault-service-version"
+          ]
+      })
     ]);
 
     return {

diff --git a/sdk/keyvault/keyvault-certificates/src/log.ts b/sdk/keyvault/keyvault-certificates/src/log.ts
@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { createClientLogger } from "@azure/logger";
+
+/**
+ * The @azure/logger configuration for this package.
+ */
+export const logger = createClientLogger("keyvault-certificates");
diff --git a/sdk/keyvault/keyvault-keys/package.json b/sdk/keyvault/keyvault-keys/package.json
@@ -72,13 +72,14 @@
     "@azure/core-http": "1.0.0-preview.6",
     "@azure/core-lro": "1.0.0-preview.1",
     "@azure/core-paging": "1.0.0-preview.2",
-    "@azure/identity": "1.0.0-preview.6",
     "@azure/core-tracing": "1.0.0-preview.5",
+    "@azure/logger": "1.0.0-preview.1",
     "tslib": "^1.9.3"
   },
   "devDependencies": {
     "@azure/abort-controller": "1.0.0-preview.2",
     "@azure/eslint-plugin-azure-sdk": "^2.0.1",
+    "@azure/identity": "1.0.0-preview.6",
     "@azure/test-utils-recorder": "1.0.0",
     "@microsoft/api-extractor": "^7.1.5",
     "@types/chai": "^4.1.6",

diff --git a/sdk/keyvault/keyvault-keys/review/keyvault-keys.api.md b/sdk/keyvault/keyvault-keys/review/keyvault-keys.api.md
@@ -226,6 +226,9 @@ export interface KeyProperties extends ParsedKeyVaultEntityIdentifier {
 // @public
 export type KeyWrapAlgorithm = "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5";
 
+// @public
+export const logger: import("@azure/logger").AzureLogger;
+
 // @public
 export interface NewPipelineOptions {
     // (undocumented)

diff --git a/sdk/keyvault/keyvault-keys/src/cryptographyClient.ts b/sdk/keyvault/keyvault-keys/src/cryptographyClient.ts
@@ -16,8 +16,11 @@ import {
   throttlingRetryPolicy,
   getDefaultProxySettings,
   userAgentPolicy,
-  getDefaultUserAgentValue
+  getDefaultUserAgentValue,
+  logPolicy
 } from "@azure/core-http";
+
+import { logger } from "./log";
 import { parseKeyvaultIdentifier } from "./core/utils";
 import { TelemetryOptions } from "./core";
 import { RetryConstants, SDK_VERSION } from "./core/utils/constants";
@@ -542,7 +545,15 @@ export class CryptographyClient {
       redirectPolicy(),
       isTokenCredential(credential)
         ? challengeBasedAuthenticationPolicy(credential)
-        : signingPolicy(credential)
+        : signingPolicy(credential),
+      logPolicy(
+        logger.info, {
+          allowedHeaderNames: [
+            "x-ms-keyvault-region",
+            "x-ms-keyvault-network-info",
+            "x-ms-keyvault-service-version"
+          ]
+      })
     ]);
 
     return {

diff --git a/sdk/keyvault/keyvault-keys/src/index.ts b/sdk/keyvault/keyvault-keys/src/index.ts
@@ -19,10 +19,12 @@ import {
   isNode,
   userAgentPolicy,
   RequestOptionsBase,
-  tracingPolicy
+  tracingPolicy,
+  logPolicy
 } from "@azure/core-http";
 
 import { getTracer, Span } from "@azure/core-tracing";
+import { logger } from "./log";
 
 import "@azure/core-paging";
 import { PageSettings, PagedAsyncIterableIterator } from "@azure/core-paging";
@@ -130,7 +132,8 @@ export {
   UnwrapResult,
   UpdateKeyOptions,
   VerifyResult,
-  WrapResult
+  WrapResult,
+  logger
 };
 
 export { ProxyOptions, TelemetryOptions, RetryOptions };
@@ -184,7 +187,15 @@ export class KeyClient {
       redirectPolicy(),
       isTokenCredential(credential)
         ? challengeBasedAuthenticationPolicy(credential)
-        : signingPolicy(credential)
+        : signingPolicy(credential),
+      logPolicy(
+        logger.info, {
+          allowedHeaderNames: [
+            "x-ms-keyvault-region",
+            "x-ms-keyvault-network-info",
+            "x-ms-keyvault-service-version"
+          ]
+      })
     ]);
 
     return {

diff --git a/sdk/keyvault/keyvault-keys/src/log.ts b/sdk/keyvault/keyvault-keys/src/log.ts
@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { createClientLogger } from "@azure/logger";
+
+/**
+ * The @azure/logger configuration for this package.
+ */
+export const logger = createClientLogger("keyvault-keys");
diff --git a/sdk/keyvault/keyvault-secrets/package.json b/sdk/keyvault/keyvault-secrets/package.json
@@ -73,13 +73,14 @@
     "@azure/core-http": "1.0.0-preview.6",
     "@azure/core-lro": "1.0.0-preview.1",
     "@azure/core-paging": "1.0.0-preview.2",
-    "@azure/identity": "1.0.0-preview.6",
     "@azure/core-tracing": "1.0.0-preview.5",
+    "@azure/logger": "1.0.0-preview.1",
     "tslib": "^1.9.3"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.1.5",
     "@azure/eslint-plugin-azure-sdk": "^2.0.1",
+    "@azure/identity": "1.0.0-preview.6",
     "@azure/test-utils-recorder": "1.0.0",
     "@types/chai": "^4.1.6",
     "@types/dotenv": "^6.1.0",

diff --git a/sdk/keyvault/keyvault-secrets/review/keyvault-secrets.api.md b/sdk/keyvault/keyvault-secrets/review/keyvault-secrets.api.md
@@ -46,6 +46,9 @@ export interface GetSecretOptions {
     version?: string;
 }
 
+// @public
+export const logger: import("@azure/logger").AzureLogger;
+
 // @public
 export interface NewPipelineOptions {
     // (undocumented)

diff --git a/sdk/keyvault/keyvault-secrets/src/index.ts b/sdk/keyvault/keyvault-secrets/src/index.ts
@@ -19,10 +19,12 @@ import {
   getDefaultProxySettings,
   isNode,
   userAgentPolicy,
-  tracingPolicy
+  tracingPolicy,
+  logPolicy
 } from "@azure/core-http";
 
 import { getTracer, Span } from "@azure/core-tracing";
+import { logger } from "./log";
 
 import "@azure/core-paging";
 import { PageSettings, PagedAsyncIterableIterator } from "@azure/core-paging";
@@ -86,7 +88,8 @@ export {
   SecretProperties,
   SecretPollerOptions,
   SetSecretOptions,
-  UpdateSecretOptions
+  UpdateSecretOptions,
+  logger
 };
 
 export { ProxyOptions, RetryOptions, TelemetryOptions };
@@ -139,7 +142,15 @@ export class SecretClient {
       redirectPolicy(),
       isTokenCredential(credential)
         ? challengeBasedAuthenticationPolicy(credential)
-        : signingPolicy(credential)
+        : signingPolicy(credential),
+      logPolicy(
+        logger.info, {
+          allowedHeaderNames: [
+            "x-ms-keyvault-region",
+            "x-ms-keyvault-network-info",
+            "x-ms-keyvault-service-version"
+          ]
+      })
     ]);
 
     return {

diff --git a/sdk/keyvault/keyvault-secrets/src/log.ts b/sdk/keyvault/keyvault-secrets/src/log.ts
@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { createClientLogger } from "@azure/logger";
+
+/**
+ * The @azure/logger configuration for this package.
+ */
+export const logger = createClientLogger("keyvault-secrets");