Skip to content

Tweak telemetry collection #3316

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

Merged
xavdid-stripe merged 1 commit into from
Mar 10, 2026
Merged

Tweak telemetry collection #3316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 11 additions & 7 deletions src/Stripe.net/Infrastructure/Public/SystemNetHttpClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,6 @@ private string BuildStripeClientUserAgentString()
{
{ "bindings_version", StripeConfiguration.StripeNetVersion },
{ "lang", ".net" },
{ "publisher", "stripe" },
{ "stripe_net_target_framework", StripeNetTargetFramework },
};

Expand All @@ -315,13 +314,18 @@ private string BuildStripeClientUserAgentString()
values.Add("lang_version", "(unknown)");
}

try
{
values.Add("os_version", RuntimeInformation.GetOSVersion());
}
catch (Exception)
if (this.EnableTelemetry)
{
values.Add("os_version", "(unknown)");
try
{
values.Add(
"platform",
$"{Environment.OSVersion} {System.Runtime.InteropServices.RuntimeInformation.ProcessArchitecture}");
}
catch (Exception)
{
values.Add("platform", "(unknown)");
}
}

try
Expand Down
44 changes: 42 additions & 2 deletions src/StripeTests/Infrastructure/Public/SystemNetHttpClientTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,47 @@ public async Task AIAgentIncludedInHeaders()
}
}

[Fact]
public async Task UserAgentOmitsPlatformWhenTelemetryDisabled()
{
var responseMessage = new HttpResponseMessage(HttpStatusCode.OK);
responseMessage.Content = new StringContent("Hello world!");
this.MockHttpClientFixture.MockHandler.Protected()
.Setup<Task<HttpResponseMessage>>(
"SendAsync",
ItExpr.IsAny<HttpRequestMessage>(),
ItExpr.IsAny<CancellationToken>())
.Returns(Task.FromResult(responseMessage));

var client = new SystemNetHttpClient(
httpClient: new HttpClient(this.MockHttpClientFixture.MockHandler.Object),
enableTelemetry: false);
var request = new StripeRequest(
this.StripeClient,
HttpMethod.Post,
"/foo",
null,
null);
await client.MakeRequestAsync(request);

this.MockHttpClientFixture.MockHandler.Protected()
.Verify(
"SendAsync",
Times.Once(),
ItExpr.Is<HttpRequestMessage>(m => this.VerifyNoPlatformHeaders(m.Headers)),
ItExpr.IsAny<CancellationToken>());
}

private bool VerifyNoPlatformHeaders(HttpRequestHeaders headers)
{
var userAgentJson = JObject.Parse(headers.GetValues("X-Stripe-Client-User-Agent").First());

Assert.Equal(".net", userAgentJson.Value<string>("lang"));
Assert.Null(userAgentJson["platform"]);

return true;
}

private bool VerifyHeaders(HttpRequestHeaders headers)
{
var userAgent = headers.UserAgent.ToString();
Expand All @@ -208,11 +249,10 @@ private bool VerifyHeaders(HttpRequestHeaders headers)
Assert.Equal("https://myawesomeapp.info", appInfo.Value<string>("url"));

Assert.Equal(".net", userAgentJson.Value<string>("lang"));
Assert.Equal("stripe", userAgentJson.Value<string>("publisher"));
Assert.NotEqual("?", userAgentJson.Value<string>("lang_version"));
Assert.NotEqual("(unknown)", userAgentJson.Value<string>("lang_version"));
Assert.NotEqual("unknown", userAgentJson.Value<string>("stripe_net_target_framework"));
Assert.NotEqual("?", userAgentJson.Value<string>("os_version"));
Assert.NotEqual("?", userAgentJson.Value<string>("platform"));
Assert.NotEmpty(userAgentJson.Value<string>("bindings_version"));
Assert.NotEmpty(userAgentJson.Value<string>("newtonsoft_json_version"));

Expand Down
Loading