Add configured and live audit instance counts to the usage report - #5938
Merged
Merged
Conversation
Adds ConfiguredInstances and LiveInstances to AuditServiceMetadata so that throughput reports can include how many audit instances are configured versus how many are actively responding. A remote is considered a live audit instance only if its configuration includes an audit queue and it has a parseable semantic version. Compatibility tests confirm that existing persisted metadata without these fields reads back with null counts.
…ed list Moving the queue list initialization inside the loop ensures each remote tracks only its own audit and audit log queues, rather than inheriting queues discovered from previous remotes. A new test confirms that two remotes each report only their own queues. The fake configuration API is also generalized to accept arbitrary remote configurations via a params constructor, replacing the single-purpose named class.
warwickschroeder
approved these changes
Sep 29, 2026
| { | ||
| List<string> queues = []; | ||
|
|
||
| foreach (var remote in remotes) |
Contributor
There was a problem hiding this comment.
Parse each remote in its own try catch, so a single bad remote doesnt discard the entire list.
Member
Author
There was a problem hiding this comment.
I looked at this @warwickschroeder, and as far as I can tell, the code is already quite defensive, everywhere we are using try..., so as far as I can see, there is no reason for a try-catch here.
Contributor
There was a problem hiding this comment.
My concern is that remote.Configuration.AsObject() would throw if any remote JSON cant be parsed, and the catch is outside of the foreach.
Comment on lines
+5
to
+6
| public int? ConfiguredInstances { get; init; } | ||
| public int? LiveInstances { get; init; } |
Contributor
There was a problem hiding this comment.
Some xml comments here would be handy explaining what these capture, and what null means.
rbev
approved these changes
Sep 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This issue was discovered as part of https://github.com/Particular/CloudPlatformExperience/pull/962#issuecomment-5826623019
Adds two counts to the environment data in the usage report.
Audit.ConfiguredInstancesis the number of audit instances the primary instance is configured with.Audit.LiveInstancesis how many of those responded as a ServiceControl audit instance at the last collection.The version and transport summaries in
AuditServicesDatacount every entry in the primary'sServiceControl/RemoteInstancessetting, whether or not the remote responds. Unreachable remotes are counted under the versionUnknownand an empty transport name. Deleting an audit instance does not remove it from the primary's list, so stale entries build up over time. Some reports show more configured audit instances than seem plausible. Nothing in the report separates stale entries from live ones.A remote counts as live when the configuration it returns contains
transport.audit_queueand itsX-Particular-Versionheader parses as a version. Only audit instances return an audit queue, so a primary instance listed as a remote does not count.The daily audit collection stores both counts in
AuditServiceMetadata. The report writes them toEnvironmentDataso that theAuditServicesDatatype from theParticular.LicensingComponent.Reportpackage does not change.Both counts are nullable. Metadata stored by an earlier version has neither count, so the report leaves both keys out until the first collection run, about 40 seconds after startup. Reports from earlier versions lack the keys too, so a missing key means the count was not reported. An earlier version reading the new metadata ignores the extra properties. Tests cover reading metadata in the old shape from RavenDB, SQL Server and PostgreSQL.
This PR also fixes a bug in
AuditQuery.GetAuditRemotes. The queue name list was created once, before the loop, so every remote got the same list holding the queues of all remotes. The only code that read the list checks whether a queue name is in it, so the bug had no visible effect. Each remote now gets its own list.