Skip to content

Commit

Permalink
Mirror: Add Prometheus stats for admin count (#323)
Browse files Browse the repository at this point in the history
## Mirror of PR #26284: [Add Prometheus stats for admin
count](space-wizards/space-station-14#26284)
from <img src="https://avatars.githubusercontent.com/u/10567778?v=4"
alt="space-wizards" width="22"/>
[space-wizards](https://github.com/space-wizards)/[space-station-14](https://github.com/space-wizards/space-station-14)

###### `a1817a12dbb385275f4273c1abf48fac0a989ddd`

PR opened by <img
src="https://avatars.githubusercontent.com/u/8107459?v=4" width="16"/><a
href="https://github.com/PJB3005"> PJB3005</a> at 2024-03-20 10:12:29
UTC

---

PR changed 2 files with 106 additions and 1 deletions.

The PR had the following labels:
- Status: Needs Review


---

<details open="true"><summary><h1>Original Body</h1></summary>

> Fixes #20828
> 
> Reports time series for admin count. Counts are separated by state
(active, AFK, or deadminned) and admin rank.
> 
> Requires engine master


</details>

Co-authored-by: SimpleStation14 <Unknown>
  • Loading branch information
SimpleStation14 authored May 28, 2024
1 parent 68c8a5e commit 4123236
Show file tree
Hide file tree
Showing 2 changed files with 106 additions and 1 deletion.
98 changes: 98 additions & 0 deletions Content.Server/Administration/Managers/AdminManager.Metrics.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
using System.Diagnostics.Metrics;
using System.Runtime.InteropServices;
using Content.Server.Afk;
using Robust.Server.DataMetrics;

namespace Content.Server.Administration.Managers;

// Handles metrics reporting for active admin count and such.

public sealed partial class AdminManager
{
private Dictionary<int, (int active, int afk, int deadminned)>? _adminOnlineCounts;

private const int SentinelRankId = -1;

[Dependency] private readonly IMetricsManager _metrics = default!;
[Dependency] private readonly IAfkManager _afkManager = default!;
[Dependency] private readonly IMeterFactory _meterFactory = default!;

private void InitializeMetrics()
{
_metrics.UpdateMetrics += MetricsOnUpdateMetrics;

var meter = _meterFactory.Create("SS14.AdminManager");

meter.CreateObservableGauge(
"admins_online_count",
MeasureAdminCount,
null,
"The count of online admins");
}

private void MetricsOnUpdateMetrics()
{
_sawmill.Verbose("Updating metrics");

var dict = new Dictionary<int, (int active, int afk, int deadminned)>();

foreach (var (session, reg) in _admins)
{
var rankId = reg.RankId ?? SentinelRankId;

ref var counts = ref CollectionsMarshal.GetValueRefOrAddDefault(dict, rankId, out _);

if (reg.Data.Active)
{
if (_afkManager.IsAfk(session))
counts.afk += 1;
else
counts.active += 1;
}
else
{
counts.deadminned += 1;
}
}

// Neither prometheus-net nor dotnet-counters seem to handle stuff well if we STOP returning measurements.
// i.e. if the last admin with a rank disconnects.
// So if we have EVER reported a rank, always keep reporting it.
if (_adminOnlineCounts != null)
{
foreach (var rank in _adminOnlineCounts.Keys)
{
CollectionsMarshal.GetValueRefOrAddDefault(dict, rank, out _);
}
}

// Make sure "no rank" is always available. Avoid "no data".
CollectionsMarshal.GetValueRefOrAddDefault(dict, SentinelRankId, out _);

_adminOnlineCounts = dict;
}

private IEnumerable<Measurement<int>> MeasureAdminCount()
{
if (_adminOnlineCounts == null)
yield break;

foreach (var (rank, (active, afk, deadminned)) in _adminOnlineCounts)
{
yield return new Measurement<int>(
active,
new KeyValuePair<string, object?>("state", "active"),
new KeyValuePair<string, object?>("rank", rank == SentinelRankId ? "none" : rank.ToString()));

yield return new Measurement<int>(
afk,
new KeyValuePair<string, object?>("state", "afk"),
new KeyValuePair<string, object?>("rank", rank == SentinelRankId ? "none" : rank.ToString()));

yield return new Measurement<int>(
deadminned,
new KeyValuePair<string, object?>("state", "deadminned"),
new KeyValuePair<string, object?>("rank", rank == SentinelRankId ? "none" : rank.ToString()));
}
}
}
9 changes: 8 additions & 1 deletion Content.Server/Administration/Managers/AdminManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

namespace Content.Server.Administration.Managers
{
public sealed class AdminManager : IAdminManager, IPostInjectInit, IConGroupControllerImplementation
public sealed partial class AdminManager : IAdminManager, IPostInjectInit, IConGroupControllerImplementation
{
[Dependency] private readonly IPlayerManager _playerManager = default!;
[Dependency] private readonly IServerDbManager _dbManager = default!;
Expand All @@ -34,6 +34,7 @@ public sealed class AdminManager : IAdminManager, IPostInjectInit, IConGroupCont
[Dependency] private readonly IServerConsoleHost _consoleHost = default!;
[Dependency] private readonly IChatManager _chat = default!;
[Dependency] private readonly ToolshedManager _toolshed = default!;
[Dependency] private readonly ILogManager _logManager = default!;

private readonly Dictionary<ICommonSession, AdminReg> _admins = new();
private readonly HashSet<NetUserId> _promotedPlayers = new();
Expand All @@ -49,6 +50,8 @@ public sealed class AdminManager : IAdminManager, IPostInjectInit, IConGroupCont
private readonly AdminCommandPermissions _commandPermissions = new();
private readonly AdminCommandPermissions _toolshedCommandPermissions = new();

private ISawmill _sawmill = default!;

public bool IsAdmin(ICommonSession session, bool includeDeAdmin = false)
{
return GetAdminData(session, includeDeAdmin) != null;
Expand Down Expand Up @@ -181,6 +184,8 @@ public void ReloadAdminsWithRank(int rankId)

public void Initialize()
{
_sawmill = _logManager.GetSawmill("admin");

_netMgr.RegisterNetMessage<MsgUpdateAdminStatus>();

// Cache permissions for loaded console commands with the requisite attributes.
Expand Down Expand Up @@ -234,6 +239,8 @@ public void Initialize()
}

_toolshed.ActivePermissionController = this;

InitializeMetrics();
}

public void PromoteHost(ICommonSession player)
Expand Down

0 comments on commit 4123236

Please sign in to comment.