Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Diagnostics: Adds Application region into Client Configuration Trace #3202

Merged
merged 5 commits into from
May 19, 2022
Merged

Diagnostics: Adds Application region into Client Configuration Trace #3202

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f86a76
Add Application region into client config trace
May 18, 2022
297c62d
add additional testing scenario
May 18, 2022
08298ec
test preferred region list is null when app region is set
May 19, 2022
a5832c1
Merge branch 'master' into users/imanvt/3198-diagnostics-log-applicat…
imanvt May 19, 2022
f67ac2d
Merge branch 'master' into users/imanvt/3198-diagnostics-log-applicat…
j82w May 19, 2022
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 Microsoft.Azure.Cosmos/src/Tracing/TraceData/ClientConfigurationTraceDatum.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public ClientConfigurationTraceDatum(CosmosClientContext cosmosClientContext, Da
cosmosClientContext.ClientOptions.AllowBulkExecution);

this.ConsistencyConfig = new ConsistencyConfig(cosmosClientContext.ClientOptions.ConsistencyLevel,
cosmosClientContext.ClientOptions.ApplicationPreferredRegions);
cosmosClientContext.ClientOptions.ApplicationPreferredRegions, cosmosClientContext.ClientOptions.ApplicationRegion);

this.cachedNumberOfClientCreated = CosmosClient.numberOfClientsCreated;
this.cachedNumberOfActiveClient = CosmosClient.NumberOfActiveClients;
Expand Down
10 changes: 7 additions & 3 deletions Microsoft.Azure.Cosmos/src/Tracing/TraceData/ConsistencyConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,23 @@ internal class ConsistencyConfig
{
public ConsistencyConfig(
ConsistencyLevel? consistencyLevel,
IReadOnlyList<string> preferredRegions)
IReadOnlyList<string> preferredRegions,
string applicationRegion)
{
this.ConsistencyLevel = consistencyLevel;
this.PreferredRegions = preferredRegions;
this.ApplicationRegion = applicationRegion;
this.lazyString = new Lazy<string>(() => string.Format(CultureInfo.InvariantCulture,
"(consistency: {0}, prgns:[{1}])",
"(consistency: {0}, prgns:[{1}], apprgn: {2})",
consistencyLevel?.ToString() ?? "NotSet",
ConsistencyConfig.PreferredRegionsInternal(preferredRegions)));
ConsistencyConfig.PreferredRegionsInternal(preferredRegions),
applicationRegion));
this.lazyJsonString = new Lazy<string>(() => Newtonsoft.Json.JsonConvert.SerializeObject(this));
}

public ConsistencyLevel? ConsistencyLevel { get; }
public IReadOnlyList<string> PreferredRegions { get; }
public string ApplicationRegion { get; }

private readonly Lazy<string> lazyString;
private readonly Lazy<string> lazyJsonString;
Expand Down
23 changes: 19 additions & 4 deletions ...re.Cosmos/tests/Microsoft.Azure.Cosmos.EmulatorTests/ClientConfigurationDiagnosticTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,21 +74,36 @@ public void ClientConfigWithOptionsTest()

ConsistencyConfig consistencyConfig = cosmosClient.ClientConfigurationTraceDatum.ConsistencyConfig;
Assert.AreEqual(consistencyConfig.ConsistencyLevel.Value, ConsistencyLevel.Session);

CosmosClientOptions clientOptions = new CosmosClientOptions
{
ApplicationRegion = "East US"
};

CosmosClientContext context = ClientContextCore.Create(
cosmosClient,
clientOptions);

ClientConfigurationTraceDatum clientConfig = new ClientConfigurationTraceDatum(context, DateTime.UtcNow);
Assert.AreEqual(clientConfig.ConsistencyConfig.ApplicationRegion, "East US");
imanvt marked this conversation as resolved.
Show resolved Hide resolved

}

[TestMethod]
public void ConsistencyConfigSerializationTest()
{
List<string> preferredRegions = new List<string> { "EastUS", "WestUs" };
ConsistencyLevel consistencyLevel = ConsistencyLevel.Session;
string appRegion = "EastUS";

ConsistencyConfig consistencyConfig = new ConsistencyConfig(consistencyLevel, preferredRegions);
Assert.AreEqual(consistencyConfig.ToString(), "(consistency: Session, prgns:[EastUS, WestUs])");
ConsistencyConfig consistencyConfig = new ConsistencyConfig(consistencyLevel, preferredRegions, appRegion);
Assert.AreEqual(consistencyConfig.ToString(), "(consistency: Session, prgns:[EastUS, WestUs], apprgn: EastUS)");

ConsistencyConfig consistencyConfigWithNull = new ConsistencyConfig(consistencyLevel: null,
preferredRegions: null);
preferredRegions: null,
applicationRegion: null);

Assert.AreEqual(consistencyConfigWithNull.ToString(), "(consistency: NotSet, prgns:[])");
Assert.AreEqual(consistencyConfigWithNull.ToString(), "(consistency: NotSet, prgns:[], apprgn: )");
}

[TestMethod]
Expand Down