Skip to content

More UserInterfaceSystem metrics #10

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
darkrell merged 4 commits into from
Jul 2, 2026
Merged

More UserInterfaceSystem metrics #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
73b51aa
BUI performance metrics
redmushie Jul 1, 2026
7080926
More touchups
redmushie Jul 1, 2026
7a87994
Add UserInterfaceSystem granular metrics CVar, default disabled
redmushie Jul 1, 2026
332a6e6
Remove half sentence
redmushie Jul 1, 2026
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
8 changes: 8 additions & 0 deletions Robust.Shared/CVars.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,6 +634,14 @@ protected CVars()
public static readonly CVarDef<string> MetricsRuntimeSocket =
CVarDef.Create("metrics.runtime_socket", "Counters", CVar.SERVERONLY);

#region Starlight
/// <summary>
/// Whether to enable granular metrics in the <see cref="SharedUserInterfaceSystem"/>.
/// </summary>
public static readonly CVarDef<bool> MetricsGranularUiSystem =
CVarDef.Create("metrics.granular_ui_system", false, CVar.SERVERONLY);
#endregion

/*
* STATUS
*/
Expand Down
112 changes: 112 additions & 0 deletions Robust.Shared/GameObjects/Systems/SharedUserInterfaceSystem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@
using Robust.Shared.Timing;
using Robust.Shared.Utility;

#region Starlight
using Prometheus;
using Robust.Shared.Configuration;
using Stopwatch = System.Diagnostics.Stopwatch;
#endregion

namespace Robust.Shared.GameObjects;

public abstract partial class SharedUserInterfaceSystem : EntitySystem
{
[Dependency] private IConfigurationManager _cfg = default!; // Starlight
[Dependency] private IDynamicTypeFactory _factory = default!;
[Dependency] private IGameTiming _timing = default!;
[Dependency] private INetManager _netManager = default!;
Expand All @@ -36,6 +43,51 @@ public abstract partial class SharedUserInterfaceSystem : EntitySystem

private ActorRangeCheckJob _rangeJob;

#region Starlight
private static readonly Histogram UpdateHistogram = Metrics.CreateHistogram(
"robust_bui_update_usage",
"Time spent in Update per phase",
new HistogramConfiguration
{
LabelNames = new[] { "phase" },
Buckets = Histogram.ExponentialBuckets(0.000_001, 1.5, 25)
});

private static readonly Histogram SetStateHistogram = Metrics.CreateHistogram(
"robust_bui_set_state_usage",
"Time spent in SetUiState per BUI type",
new HistogramConfiguration
{
LabelNames = new[] { "bui" },
Buckets = Histogram.ExponentialBuckets(0.000_001, 1.5, 25)
});

private static readonly Histogram RangeCheckHistogram = Metrics.CreateHistogram(
"robust_bui_range_check_usage",
"Time spent in range checks per BUI key type",
new HistogramConfiguration
{
LabelNames = new[] { "bui" },
Buckets = Histogram.ExponentialBuckets(0.000_001, 1.5, 25)
});

// The three 'phases' of the Update method.
private static readonly Histogram.Child MonitorRangeQuery = UpdateHistogram.WithLabels("RangeQuery");
private static readonly Histogram.Child MonitorRangeParallel = UpdateHistogram.WithLabels("RangeParallel");
private static readonly Histogram.Child MonitorRangeClose = UpdateHistogram.WithLabels("RangeClose");

// Reused histogram children per BUI / BUI key type.
private readonly Dictionary<Type, Histogram.Child> _setStateMonitors = new();
private readonly Dictionary<Type, Histogram.Child> _rangeCheckMonitors = new();

private readonly Stopwatch _stopwatch = new();

private bool _globalMetricsEnabled;
private bool _granularUiSystemMetricsEnabled;
private bool MetricsEnabled => _globalMetricsEnabled && _granularUiSystemMetricsEnabled;

#endregion Starlight

/// <summary>
/// Defer BUIs during state handling so client doesn't spam a BUI constantly during prediction.
/// </summary>
Expand All @@ -45,6 +97,14 @@ public override void Initialize()
{
base.Initialize();

// Starlight BEGIN
if (_netManager.IsServer)
{
Subs.CVar(_cfg, CVars.MetricsEnabled, v => _globalMetricsEnabled = v, true);
Subs.CVar(_cfg, CVars.MetricsGranularUiSystem, v => _granularUiSystemMetricsEnabled = v, true);
}
// Starlight END

EntityManager.ComponentFactory.RegisterNetworkedFields<UserInterfaceComponent>(
nameof(UserInterfaceComponent.Actors),
nameof(UserInterfaceComponent.Interfaces),
Expand Down Expand Up @@ -733,6 +793,17 @@ public void SetUiState(Entity<UserInterfaceComponent?> entity, Enum key, BoundUs
if (!entity.Comp.Interfaces.ContainsKey(key))
return;

// Starlight BEGIN
Histogram.Child? monitor = null;
if (MetricsEnabled && state != null)
{
var type = state.GetType();
if (!_setStateMonitors.TryGetValue(type, out monitor))
_setStateMonitors[type] = monitor = SetStateHistogram.WithLabels(type.Name);
_stopwatch.Restart();
}
// Starlight END

// Null state
if (state == null)
{
Expand Down Expand Up @@ -763,6 +834,7 @@ public void SetUiState(Entity<UserInterfaceComponent?> entity, Enum key, BoundUs
}

DirtyField(entity, nameof(UserInterfaceComponent.States));
monitor?.Observe(_stopwatch.Elapsed.TotalSeconds); // Starlight
}

/// <summary>
Expand Down Expand Up @@ -1161,6 +1233,11 @@ public override void Update(float frameTime)
_queuedBuis.Clear();
}

// Starlight BEGIN
if (MetricsEnabled)
_stopwatch.Restart();
// Starlight END

var query = AllEntityQuery<ActiveUserInterfaceComponent, UserInterfaceComponent>();
// Run these in parallel because it's expensive.
_rangeJob.ActorRanges.Clear();
Expand All @@ -1185,13 +1262,39 @@ public override void Update(float frameTime)
if (_netManager.IsClient && !actor.IsValid())
continue; // Client might not have received the entity. Server should log errors.

// Starlight BEGIN
if (MetricsEnabled)
{
var keyType = key.GetType();
if (!_rangeCheckMonitors.ContainsKey(keyType))
_rangeCheckMonitors[keyType] = RangeCheckHistogram.WithLabels(keyType.Name);
}
// Starlight END

_rangeJob.ActorRanges.Add((uid, key, data, actor, false));
}
}
}

// Starlight BEGIN
_rangeJob.RangeMonitors = MetricsEnabled ? _rangeCheckMonitors : null;
if (MetricsEnabled)
{
MonitorRangeQuery.Observe(_stopwatch.Elapsed.TotalSeconds);
_stopwatch.Restart();
}
// Starlight END

_parallel.ProcessNow(_rangeJob, _rangeJob.ActorRanges.Count);

// Starlight BEGIN
if (MetricsEnabled)
{
MonitorRangeParallel.Observe(_stopwatch.Elapsed.TotalSeconds);
_stopwatch.Restart();
}
// Starlight END

foreach (var data in _rangeJob.ActorRanges)
{
var uid = data.Ui;
Expand All @@ -1203,6 +1306,11 @@ public override void Update(float frameTime)

CloseUi((uid, uiComp), key, actor);
}

// Starlight BEGIN
if (MetricsEnabled)
MonitorRangeClose.Observe(_stopwatch.Elapsed.TotalSeconds);
// Starlight END
}

/// <summary>
Expand Down Expand Up @@ -1268,6 +1376,7 @@ private record struct ActorRangeCheckJob() : IParallelRobustJob
{
public required EntityQuery<TransformComponent> XformQuery;
public required SharedUserInterfaceSystem System;
public Dictionary<Type, Histogram.Child>? RangeMonitors; // Starlight: Monitoring
public readonly List<(EntityUid Ui, Enum Key, InterfaceData Data, EntityUid Actor, bool Result)> ActorRanges = new();

public void Execute(int index)
Expand All @@ -1281,7 +1390,10 @@ public void Execute(int index)
}
else
{
var start = Stopwatch.GetTimestamp(); // Starlight
data.Result = System.CheckRange((data.Ui, uiXform), data.Key, data.Data, (data.Actor, actorXform));
if (RangeMonitors != null && RangeMonitors.TryGetValue(data.Key.GetType(), out var monitor)) // Starlight
monitor.Observe(Stopwatch.GetElapsedTime(start).TotalSeconds); // Starlight
}

ActorRanges[index] = data;
Expand Down
Loading