Skip to content

Add the missing usage report keys for the primary instance, its storage and its transport - #5945

Merged
johnsimons merged 2 commits into
masterfrom
john/missing_telemetry
Oct 6, 2026
Merged

johnsimons merged 2 commits into
masterfrom
john/missing_telemetry

Conversation

@johnsimons

Copy link
Copy Markdown
Member

This PR just adds all the missing settings that the user can customise.

… the usage report

Expands the environment data collected for the usage report to cover transport authentication and options (ASBS, SQS, RabbitMQ, SQL Server, PostgreSQL), storage authentication and tuning (RavenDB, SQL Server, PostgreSQL, EF Core), and error instance settings (ingestion tuning, heartbeats, recoverability, security posture, ServicePulse integration, logging, and OTLP metrics).

Values are reported as fixed labels rather than raw configuration values, so customer-specific details (queue names, endpoints, secrets, hostnames, claim names) are never exposed.

@warwickschroeder warwickschroeder left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Confirmed no real data is being collected, only fixed words to indicate use.

I noticed that some transports dont have overrides - IBM MQ, ASQ, MSMQ. Looks like ASQ is feature complete, and MSMQ is suset so thats probably why. IBM MQ is active though.


protected virtual string GetAuthenticationMode(TransportSettings transportSettings) => "NotApplicable";

protected virtual bool RelaxesCertificateValidation(TransportSettings transportSettings) => false;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like only Rabbit overrides this? SqlServerTransportCustomization could override this to look for TrustServerCertificate=True, and postgres to look for SslMode=Require. I think the other transports probably also have a ssl switch that could be parsed potentially.

…eport

Drops the Transport.Auth, Transport.CertificateValidation, Storage.Auth, Storage.BodyStorage.Auth, and Security.* environment data keys (and their providers/tests) that reported authentication modes and security hardening posture.

Simplifies TransportCustomization by replacing the GetAuthenticationMode/RelaxesCertificateValidation/GetEnvironmentDataCore template method with a single overridable GetEnvironmentData method.

Also fixes SQL Server and PostgreSQL version reporting to return a reliable numeric major version instead of the raw version string, and adds coverage for the SqlVersion query data.
johnsimons added a commit that referenced this pull request Oct 6, 2026
Revises the 2026-10-01 coverage decision: security settings (authentication, HTTPS, CORS, forwarded headers, transport/database auth and encryption) are no longer reported, since a security reviewer could otherwise block the whole signed report and licensing has no need for the data.

Also narrows scope further: `SqlVersion` now reports only the major version (or `AzureSql`), and email notification details and licensed endpoint details are dropped as out of scope. Updates `docs/usage-report.md` to match, adding the "Security configuration" exclusion reason and removing the Security key table.

Links PR #5945 as the first implementation PR.
@johnsimons
johnsimons merged commit 5552198 into master Oct 6, 2026
68 of 70 checks passed
@johnsimons
johnsimons deleted the john/missing_telemetry branch October 6, 2026 04:45
@johnsimons

Copy link
Copy Markdown
Member Author

noticed that some transports dont have overrides - IBM MQ

@warwickschroeder I reviewed this, and as far as I can see, there is nothing we need to collect here, since we are not collecting anything related to security settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants