Skip to content

Add requestTracingOptions #114

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.

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
merged 1 commit into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/AzureAppConfigurationImpl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
this.#options = options;

// Enable request tracing if not opt-out
this.#requestTracingEnabled = requestTracingEnabled();
this.#requestTracingEnabled = options?.requestTracingOptions?.enabled ?? requestTracingEnabled();

if (options?.trimKeyPrefixes) {
this.#sortedTrimKeyPrefixes = [...options.trimKeyPrefixes].sort((a, b) => b.localeCompare(a));
Expand Down
6 changes: 6 additions & 0 deletions src/AzureAppConfigurationOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { KeyVaultOptions } from "./keyvault/KeyVaultOptions.js";
import { RefreshOptions } from "./RefreshOptions.js";
import { SettingSelector } from "./types.js";
import { FeatureFlagOptions } from "./featureManagement/FeatureFlagOptions.js";
import { RequestTracingOptions } from "./requestTracing/RequestTracingOptions.js";

export const MaxRetries = 2;
export const MaxRetryDelayInMs = 60000;
Expand Down Expand Up @@ -47,4 +48,9 @@ export interface AzureAppConfigurationOptions {
* Specifies options used to configure feature flags.
*/
featureFlagOptions?: FeatureFlagOptions;

/**
* Specifies options used to configure request tracing.
*/
requestTracingOptions?: RequestTracingOptions;
}
12 changes: 12 additions & 0 deletions src/requestTracing/RequestTracingOptions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

/**
* Options used to configure request tracing.
*/
export interface RequestTracingOptions {
/**
* Specifies whether request tracing is enabled.
*/
enabled: boolean;
}
14 changes: 14 additions & 0 deletions test/requestTracing.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,20 @@ describe("request tracing", function () {
delete process.env.AZURE_APP_CONFIGURATION_TRACING_DISABLED;
});

it("should disable request tracing by RequestTracingOptions", async () => {
try {
await load(createMockedConnectionString(fakeEndpoint), {
clientOptions,
requestTracingOptions: {
enabled: false
}
});
} catch (e) { /* empty */ }
expect(headerPolicy.headers).not.undefined;
const correlationContext = headerPolicy.headers.get("Correlation-Context");
expect(correlationContext).undefined;
});

it("should have request type in correlation-context header when refresh is enabled", async () => {
mockAppConfigurationClientListConfigurationSettings([{
key: "app.settings.fontColor",
Expand Down
Loading