Merge pull request #141 from Azure/zhiyuanliang/replica-count-tracing

Add replica count tracing

Author: zhiyuanliang-ms

package-lock.json

@@ -33,7 +33,7 @@ import {
 } from "./featureManagement/constants.js";
 import { AzureKeyVaultKeyValueAdapter } from "./keyvault/AzureKeyVaultKeyValueAdapter.js";
 import { RefreshTimer } from "./refresh/RefreshTimer.js";
-import { getConfigurationSettingWithTrace, listConfigurationSettingsWithTrace, requestTracingEnabled } from "./requestTracing/utils.js";
+import { RequestTracingOptions, getConfigurationSettingWithTrace, listConfigurationSettingsWithTrace, requestTracingEnabled } from "./requestTracing/utils.js";
 import { KeyFilter, LabelFilter, SettingSelector } from "./types.js";
 import { ConfigurationClientManager } from "./ConfigurationClientManager.js";
 
@@ -197,11 +197,12 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
         return this.#featureFlagEnabled && !!this.#options?.featureFlagOptions?.refresh?.enabled;
     }
 
-    get #requestTraceOptions() {
+    get #requestTraceOptions(): RequestTracingOptions {
         return {
-            requestTracingEnabled: this.#requestTracingEnabled,
-            initialLoadCompleted: this.#isInitialLoadCompleted,
+            enabled: this.#requestTracingEnabled,
             appConfigOptions: this.#options,
+            initialLoadCompleted: this.#isInitialLoadCompleted,
+            replicaCount: this.#clientManager.getReplicaCount(),
             isFailoverRequest: this.#isFailoverRequest
         };
     }

src/AzureAppConfigurationImpl.ts

@@ -30,8 +30,9 @@ export class ConfigurationClientManager {
     #clientOptions: AppConfigurationClientOptions | undefined;
     #appConfigOptions: AzureAppConfigurationOptions | undefined;
     #validDomain: string;
-    #staticClients: ConfigurationClientWrapper[];
+    #staticClients: ConfigurationClientWrapper[]; // there should always be only one static client
     #dynamicClients: ConfigurationClientWrapper[];
+    #replicaCount: number = 0;
     #lastFallbackClientRefreshTime: number = 0;
     #lastFallbackClientRefreshAttempt: number = 0;
 
@@ -96,7 +97,11 @@ export class ConfigurationClientManager {
         this.#isFailoverable = true;
     }
 
-    async getClients() : Promise<ConfigurationClientWrapper[]> {
+    getReplicaCount(): number {
+        return this.#replicaCount;
+    }
+
+    async getClients(): Promise<ConfigurationClientWrapper[]> {
         if (!this.#isFailoverable) {
             return this.#staticClients;
         }
@@ -161,6 +166,7 @@ export class ConfigurationClientManager {
 
         this.#dynamicClients = newDynamicClients;
         this.#lastFallbackClientRefreshTime = Date.now();
+        this.#replicaCount = this.#dynamicClients.length;
     }
 
     /**

src/ConfigurationClientManager.ts

@@ -37,16 +37,20 @@ export const CONTAINER_APP_ENV_VAR = "CONTAINER_APP_NAME";
 export const KUBERNETES_ENV_VAR = "KUBERNETES_PORT";
 export const SERVICE_FABRIC_ENV_VAR = "Fabric_NodeName"; // See: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-environment-variables-reference
 
-// Request Type
+// Request type
 export const REQUEST_TYPE_KEY = "RequestType";
 export enum RequestType {
     STARTUP = "Startup",
     WATCH = "Watch"
 }
 
-export const FEATURES_KEY = "Features";
+// Replica count
+export const REPLICA_COUNT_KEY = "ReplicaCount";
 
 // Tag names
-export const FAILOVER_REQUEST_TAG = "Failover";
 export const KEY_VAULT_CONFIGURED_TAG = "UsesKeyVault";
+export const FAILOVER_REQUEST_TAG = "Failover";
+
+// Compact feature tags
+export const FEATURES_KEY = "Features";
 export const LOAD_BALANCE_CONFIGURED_TAG = "LB";