From 0e430dd7d61d70e779d3024429d912febd5e9295 Mon Sep 17 00:00:00 2001 From: Abrynos <6608231+Abrynos@users.noreply.github.com> Date: Thu, 25 Apr 2024 20:43:18 +0200 Subject: [PATCH 1/3] Monitor incoming trades --- .../MonitoringPlugin.cs | 67 +++++++++++++++- .../TagNames.cs | 1 + .../TradeStatistics.cs | 79 +++++++++++++++++++ 3 files changed, 146 insertions(+), 1 deletion(-) create mode 100644 ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs diff --git a/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs b/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs index dafb948d643a2..8c2a245c80d16 100644 --- a/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs +++ b/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs @@ -22,6 +22,7 @@ // limitations under the License. using System; +using System.Collections.Concurrent; using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.Composition; @@ -35,6 +36,7 @@ using ArchiSteamFarm.Plugins; using ArchiSteamFarm.Plugins.Interfaces; using ArchiSteamFarm.Steam; +using ArchiSteamFarm.Steam.Exchange; using ArchiSteamFarm.Storage; using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; @@ -45,7 +47,7 @@ namespace ArchiSteamFarm.OfficialPlugins.Monitoring; [Export(typeof(IPlugin))] [SuppressMessage("ReSharper", "MemberCanBeFileLocal")] -internal sealed class MonitoringPlugin : OfficialPlugin, IDisposable, IOfficialGitHubPluginUpdates, IWebInterface, IWebServiceProvider { +internal sealed class MonitoringPlugin : OfficialPlugin, IDisposable, IOfficialGitHubPluginUpdates, IWebInterface, IWebServiceProvider, IBotTradeOfferResults { private const string MeterName = SharedInfo.AssemblyName; private const string MetricNamePrefix = "asf"; @@ -77,10 +79,25 @@ internal sealed class MonitoringPlugin : OfficialPlugin, IDisposable, IOfficialG [Required] public override Version Version => typeof(MonitoringPlugin).Assembly.GetName().Version ?? throw new InvalidOperationException(nameof(Version)); + private readonly ConcurrentDictionary TradeStatistics = new(); + private Meter? Meter; public void Dispose() => Meter?.Dispose(); + public Task OnBotTradeOfferResults(Bot bot, IReadOnlyCollection tradeResults) { + ArgumentNullException.ThrowIfNull(bot); + ArgumentNullException.ThrowIfNull(tradeResults); + + TradeStatistics statistics = TradeStatistics.GetOrAdd(bot, static _ => new TradeStatistics()); + + foreach (ParseTradeResult result in tradeResults) { + statistics.Include(result); + } + + return Task.CompletedTask; + } + public void OnConfiguringEndpoints(IApplicationBuilder app) { ArgumentNullException.ThrowIfNull(app); @@ -230,5 +247,53 @@ internal sealed class MonitoringPlugin : OfficialPlugin, IDisposable, IOfficialG }, description: "Remaining games to redeem in background per bot" ); + + Meter.CreateObservableCounter( + $"{MetricNamePrefix}_bot_trades", () => TradeStatistics.SelectMany, Measurement>( + static kv => [ + new Measurement( + kv.Value.AcceptedOffers, + new KeyValuePair(TagNames.BotName, kv.Key.BotName), + new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), + new KeyValuePair(TagNames.TradeOfferResult, "accepted") + ), + new Measurement( + kv.Value.RejectedOffers, + new KeyValuePair(TagNames.BotName, kv.Key.BotName), + new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), + new KeyValuePair(TagNames.TradeOfferResult, "rejected") + ), + new Measurement( + kv.Value.IgnoredOffers, + new KeyValuePair(TagNames.BotName, kv.Key.BotName), + new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), + new KeyValuePair(TagNames.TradeOfferResult, "ignored") + ), + new Measurement( + kv.Value.BlacklistedOffers, + new KeyValuePair(TagNames.BotName, kv.Key.BotName), + new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), + new KeyValuePair(TagNames.TradeOfferResult, "blacklisted") + ), + new Measurement( + kv.Value.ConfirmedOffers, + new KeyValuePair(TagNames.BotName, kv.Key.BotName), + new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), + new KeyValuePair(TagNames.TradeOfferResult, "2fa_confirmed") + ) + ] + ), + description: "Trade offers per bot and action taken by ASF" + ); + + Meter.CreateObservableCounter( + $"{MetricNamePrefix}_bot_items_given", () => TradeStatistics.Select(static kv => new Measurement(kv.Value.ItemsGiven, new KeyValuePair(TagNames.BotName, kv.Key.BotName), new KeyValuePair(TagNames.SteamID, kv.Key.SteamID))), + description: "Items given per bot" + ); + + Meter.CreateObservableCounter( + $"{MetricNamePrefix}_bot_items_received", () => TradeStatistics.Select(static kv => new Measurement(kv.Value.ItemsReceived, new KeyValuePair(TagNames.BotName, kv.Key.BotName), new KeyValuePair(TagNames.SteamID, kv.Key.SteamID))), + description: "Items received per bot" + ); } } diff --git a/ArchiSteamFarm.OfficialPlugins.Monitoring/TagNames.cs b/ArchiSteamFarm.OfficialPlugins.Monitoring/TagNames.cs index 8945c3ea5f844..0fba405001d14 100644 --- a/ArchiSteamFarm.OfficialPlugins.Monitoring/TagNames.cs +++ b/ArchiSteamFarm.OfficialPlugins.Monitoring/TagNames.cs @@ -31,6 +31,7 @@ internal static class TagNames { internal const string OS = "operating_system"; internal const string Runtime = "runtime"; internal const string SteamID = "steamid"; + internal const string TradeOfferResult = "result"; internal const string Variant = "variant"; internal const string Version = "version"; } diff --git a/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs b/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs new file mode 100644 index 0000000000000..35ae2a9f7a157 --- /dev/null +++ b/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs @@ -0,0 +1,79 @@ +// ---------------------------------------------------------------------------------------------- +// _ _ _ ____ _ _____ +// / \ _ __ ___ | |__ (_)/ ___| | |_ ___ __ _ _ __ ___ | ___|__ _ _ __ _ __ ___ +// / _ \ | '__|/ __|| '_ \ | |\___ \ | __|/ _ \ / _` || '_ ` _ \ | |_ / _` || '__|| '_ ` _ \ +// / ___ \ | | | (__ | | | || | ___) || |_| __/| (_| || | | | | || _|| (_| || | | | | | | | +// /_/ \_\|_| \___||_| |_||_||____/ \__|\___| \__,_||_| |_| |_||_| \__,_||_| |_| |_| |_| +// ---------------------------------------------------------------------------------------------- +// | +// Copyright 2015-2024 Łukasz "JustArchi" Domeradzki +// Contact: JustArchi@JustArchi.net +// | +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// | +// http://www.apache.org/licenses/LICENSE-2.0 +// | +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +using System; +using ArchiSteamFarm.Steam.Exchange; + +namespace ArchiSteamFarm.OfficialPlugins.Monitoring; + +internal sealed class TradeStatistics { + private readonly object Lock = new(); + + internal uint AcceptedOffers { get; private set; } + + internal uint BlacklistedOffers { get; private set; } + + internal uint ConfirmedOffers { get; private set; } + + internal uint IgnoredOffers { get; private set; } + + internal uint ItemsGiven { get; private set; } + + internal uint ItemsReceived { get; private set; } + + internal uint RejectedOffers { get; private set; } + + internal void Include(ParseTradeResult result) { + ArgumentNullException.ThrowIfNull(result); + + lock (Lock) { + if (result is { Result: ParseTradeResult.EResult.Accepted, Confirmed: true }) { + ItemsGiven += (uint) (result.ItemsToGive?.Count ?? 0); + ItemsReceived += (uint) (result.ItemsToReceive?.Count ?? 0); + } + + switch (result.Result) { + case ParseTradeResult.EResult.Accepted: + ++AcceptedOffers; + + break; + case ParseTradeResult.EResult.Rejected: + ++RejectedOffers; + + break; + case ParseTradeResult.EResult.Blacklisted: + ++BlacklistedOffers; + + break; + case ParseTradeResult.EResult.Ignored: + ++IgnoredOffers; + + break; + } + + if (result.Confirmed) { + ++ConfirmedOffers; + } + } + } +} From 1383e82470aa60a2db36b103b5d6d49b83fadb26 Mon Sep 17 00:00:00 2001 From: Abrynos <6608231+Abrynos@users.noreply.github.com> Date: Wed, 22 May 2024 21:17:49 +0200 Subject: [PATCH 2/3] Apply feedback --- .../TradeStatistics.cs | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs b/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs index 35ae2a9f7a157..fbb2206835c1a 100644 --- a/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs +++ b/ArchiSteamFarm.OfficialPlugins.Monitoring/TradeStatistics.cs @@ -47,12 +47,13 @@ internal sealed class TradeStatistics { ArgumentNullException.ThrowIfNull(result); lock (Lock) { - if (result is { Result: ParseTradeResult.EResult.Accepted, Confirmed: true }) { - ItemsGiven += (uint) (result.ItemsToGive?.Count ?? 0); - ItemsReceived += (uint) (result.ItemsToReceive?.Count ?? 0); - } - switch (result.Result) { + case ParseTradeResult.EResult.Accepted when result.Confirmed: + ++ConfirmedOffers; + ItemsGiven += (uint) (result.ItemsToGive?.Count ?? 0); + ItemsReceived += (uint) (result.ItemsToReceive?.Count ?? 0); + + goto case ParseTradeResult.EResult.Accepted; case ParseTradeResult.EResult.Accepted: ++AcceptedOffers; @@ -70,10 +71,6 @@ internal sealed class TradeStatistics { break; } - - if (result.Confirmed) { - ++ConfirmedOffers; - } } } } From 407a531542e938729c660fc6104bf970f20975af Mon Sep 17 00:00:00 2001 From: Abrynos <6608231+Abrynos@users.noreply.github.com> Date: Tue, 28 May 2024 17:56:02 +0200 Subject: [PATCH 3/3] Misc. --- ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs b/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs index 8c2a245c80d16..c4e6b12bec2c7 100644 --- a/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs +++ b/ArchiSteamFarm.OfficialPlugins.Monitoring/MonitoringPlugin.cs @@ -279,7 +279,7 @@ internal sealed class MonitoringPlugin : OfficialPlugin, IDisposable, IOfficialG kv.Value.ConfirmedOffers, new KeyValuePair(TagNames.BotName, kv.Key.BotName), new KeyValuePair(TagNames.SteamID, kv.Key.SteamID), - new KeyValuePair(TagNames.TradeOfferResult, "2fa_confirmed") + new KeyValuePair(TagNames.TradeOfferResult, "confirmed") ) ] ),