Skip to content

Remove stale gauges from dotnet-counters UI #3221

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
noahfalk merged 2 commits into from
Jul 26, 2022
Merged

Remove stale gauges from dotnet-counters UI #3221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1671819
Remove stale gauges from dotnet-counters UI
noahfalk Jul 22, 2022
c45ed7a
Renaming fields to match conventions
noahfalk Jul 26, 2022
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
7 changes: 7 additions & 0 deletions src/Tools/dotnet-counters/CounterMonitor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ private void HandleCounterRate(TraceEvent obj)
CounterPayload payload = new RatePayload(meterName, instrumentName, null, unit, tags, rate, _interval, obj.TimeStamp);
_renderer.CounterPayloadReceived(payload, _pauseCmdSet);
}

}

private void HandleGauge(TraceEvent obj)
Expand All @@ -192,6 +193,12 @@ private void HandleGauge(TraceEvent obj)
CounterPayload payload = new GaugePayload(meterName, instrumentName, null, unit, tags, lastValue, obj.TimeStamp);
_renderer.CounterPayloadReceived(payload, _pauseCmdSet);
}
else
{
// for observable instruments we assume the lack of data is meaningful and remove it from the UI
CounterPayload payload = new RatePayload(meterName, instrumentName, null, unit, tags, 0, _interval, obj.TimeStamp);
_renderer.CounterStopped(payload);
}
}

private void HandleHistogram(TraceEvent obj)
Expand Down
2 changes: 2 additions & 0 deletions src/Tools/dotnet-counters/Exporters/CSVExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ public void CounterPayloadReceived(CounterPayload payload, bool _)
}
}

public void CounterStopped(CounterPayload payload) { }

public void Stop()
{
string outputString;
Expand Down
104 changes: 73 additions & 31 deletions src/Tools/dotnet-counters/Exporters/ConsoleWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,22 +56,22 @@ public ObservedTagSet(string tags)
}

private readonly object _lock = new object();
private readonly Dictionary<string, ObservedProvider> providers = new Dictionary<string, ObservedProvider>(); // Tracks observed providers and counters.
private readonly Dictionary<string, ObservedProvider> _providers = new Dictionary<string, ObservedProvider>(); // Tracks observed providers and counters.
private const int Indent = 4; // Counter name indent size.
private int maxNameLength = 40; // Allow room for 40 character counter names by default.
private int _maxNameLength = 40; // Allow room for 40 character counter names by default.

private int STATUS_ROW; // Row # of where we print the status of dotnet-counters
private int Top_Row;
private bool paused = false;
private bool initialized = false;
private int _statusRow; // Row # of where we print the status of dotnet-counters
private int _topRow;
private bool _paused = false;
private bool _initialized = false;
private string _errorText = null;

private int maxRow = -1;
private bool useAnsi = false;
private int _maxRow = -1;
private bool _useAnsi = false;

public ConsoleWriter(bool useAnsi)
{
this.useAnsi = useAnsi;
this._useAnsi = useAnsi;
}

public void Initialize()
Expand All @@ -92,9 +92,9 @@ public void SetErrorText(string errorText)

private void SetCursorPosition(int col, int row)
{
if (this.useAnsi)
if (this._useAnsi)
{
Console.Write($"\u001b[{row + 1 - Top_Row};{col + 1}H");
Console.Write($"\u001b[{row + 1 - _topRow};{col + 1}H");
}
else
{
Expand All @@ -104,7 +104,7 @@ private void SetCursorPosition(int col, int row)

private void Clear()
{
if (this.useAnsi)
if (this._useAnsi)
{
Console.Write($"\u001b[H\u001b[J");
}
Expand All @@ -115,34 +115,34 @@ private void Clear()
}
private void UpdateStatus()
{
SetCursorPosition(0, STATUS_ROW);
SetCursorPosition(0, _statusRow);
Console.Write($" Status: {GetStatus()}{new string(' ', 40)}"); // Write enough blanks to clear previous status.
}

private string GetStatus() => !initialized ? "Waiting for initial payload..." : (paused ? "Paused" : "Running");
private string GetStatus() => !_initialized ? "Waiting for initial payload..." : (_paused ? "Paused" : "Running");

/// <summary>Clears display and writes out category and counter name layout.</summary>
public void AssignRowsAndInitializeDisplay()
{
Clear();

int row = Console.CursorTop;
Top_Row = row;
_topRow = row;
Console.WriteLine("Press p to pause, r to resume, q to quit."); row++;
Console.WriteLine($" Status: {GetStatus()}"); STATUS_ROW = row++;
Console.WriteLine($" Status: {GetStatus()}"); _statusRow = row++;
if (_errorText != null)
{
Console.WriteLine(_errorText);
row += GetLineWrappedLines(_errorText);
}
Console.WriteLine(); row++; // Blank line.

foreach (ObservedProvider provider in providers.Values.OrderBy(p => p.KnownProvider == null).ThenBy(p => p.Name)) // Known providers first.
foreach (ObservedProvider provider in _providers.Values.OrderBy(p => p.KnownProvider == null).ThenBy(p => p.Name)) // Known providers first.
{
Console.WriteLine($"[{provider.Name}]"); row++;
foreach (ObservedCounter counter in provider.Counters.Values.OrderBy(c => c.DisplayName))
{
string name = MakeFixedWidth($"{new string(' ', Indent)}{counter.DisplayName}", Indent + maxNameLength);
string name = MakeFixedWidth($"{new string(' ', Indent)}{counter.DisplayName}", Indent + _maxNameLength);
counter.Row = row++;
if (counter.RenderValueInline)
{
Expand All @@ -153,35 +153,35 @@ public void AssignRowsAndInitializeDisplay()
Console.WriteLine(name);
foreach (ObservedTagSet tagSet in counter.TagSets.Values.OrderBy(t => t.Tags))
{
string tagName = MakeFixedWidth($"{new string(' ', 2 * Indent)}{tagSet.Tags}", Indent + maxNameLength);
string tagName = MakeFixedWidth($"{new string(' ', 2 * Indent)}{tagSet.Tags}", Indent + _maxNameLength);
Console.WriteLine($"{tagName} {FormatValue(tagSet.LastValue)}");
tagSet.Row = row++;
}
}
}
}

maxRow = Math.Max(maxRow, row);
_maxRow = Math.Max(_maxRow, row);
}

public void ToggleStatus(bool pauseCmdSet)
{
if (paused == pauseCmdSet)
if (_paused == pauseCmdSet)
{
return;
}

paused = pauseCmdSet;
_paused = pauseCmdSet;
UpdateStatus();
}

public void CounterPayloadReceived(CounterPayload payload, bool pauseCmdSet)
{
lock (_lock)
{
if (!initialized)
if (!_initialized)
{
initialized = true;
_initialized = true;
AssignRowsAndInitializeDisplay();
}

Expand All @@ -195,17 +195,17 @@ public void CounterPayloadReceived(CounterPayload payload, bool pauseCmdSet)
string tags = payload.Tags;

bool redraw = false;
if (!providers.TryGetValue(providerName, out ObservedProvider provider))
if (!_providers.TryGetValue(providerName, out ObservedProvider provider))
{
providers[providerName] = provider = new ObservedProvider(providerName);
_providers[providerName] = provider = new ObservedProvider(providerName);
redraw = true;
}

if (!provider.Counters.TryGetValue(name, out ObservedCounter counter))
{
string displayName = payload.DisplayName;
provider.Counters[name] = counter = new ObservedCounter(displayName);
maxNameLength = Math.Max(maxNameLength, displayName.Length);
_maxNameLength = Math.Max(_maxNameLength, displayName.Length);
if(tags != null)
{
counter.LastValue = payload.Value;
Expand All @@ -217,7 +217,7 @@ public void CounterPayloadReceived(CounterPayload payload, bool pauseCmdSet)
if (tags != null && !counter.TagSets.TryGetValue(tags, out tagSet))
{
counter.TagSets[tags] = tagSet = new ObservedTagSet(tags);
maxNameLength = Math.Max(maxNameLength, tagSet.DisplayTags.Length);
_maxNameLength = Math.Max(_maxNameLength, tagSet.DisplayTags.Length);
tagSet.LastValue = payload.Value;
redraw = true;
}
Expand All @@ -228,11 +228,53 @@ public void CounterPayloadReceived(CounterPayload payload, bool pauseCmdSet)
}

int row = counter.RenderValueInline ? counter.Row : tagSet.Row;
SetCursorPosition(Indent + maxNameLength + 1, row);
SetCursorPosition(Indent + _maxNameLength + 1, row);
Console.Write(FormatValue(payload.Value));
}
}

public void CounterStopped(CounterPayload payload)
{
lock (_lock)
{
string providerName = payload.ProviderName;
string counterName = payload.Name;
string tags = payload.Tags;

if (!_providers.TryGetValue(providerName, out ObservedProvider provider))
{
return;
}

if (!provider.Counters.TryGetValue(counterName, out ObservedCounter counter))
{
return;
}

ObservedTagSet tagSet = null;
if (tags != null)
{
if (!counter.TagSets.TryGetValue(tags, out tagSet))
{
return;
}
else
{
counter.TagSets.Remove(tags);
if(counter.TagSets.Count == 0)
{
provider.Counters.Remove(counterName);
}
}
}
else
{
provider.Counters.Remove(counterName);
}
AssignRowsAndInitializeDisplay();
}
}

private static int GetLineWrappedLines(string text)
{
string[] lines = text.Split(Environment.NewLine);
Expand Down Expand Up @@ -305,9 +347,9 @@ public void Stop()
{
lock (_lock)
{
if (initialized)
if (_initialized)
{
var row = maxRow;
var row = _maxRow;

if (row > -1)
{
Expand Down
1 change: 1 addition & 0 deletions src/Tools/dotnet-counters/Exporters/ICounterRenderer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ public interface ICounterRenderer
void EventPipeSourceConnected();
void ToggleStatus(bool paused);
void CounterPayloadReceived(CounterPayload payload, bool paused);
void CounterStopped(CounterPayload payload);
void SetErrorText(string errorText);
void Stop();
}
Expand Down
2 changes: 2 additions & 0 deletions src/Tools/dotnet-counters/Exporters/JSONExporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ public void CounterPayloadReceived(CounterPayload payload, bool _)
}
}

public void CounterStopped(CounterPayload payload) { }

public void Stop()
{
lock (_lock)
Expand Down