123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425 |
- /*
- * Copyright (c) Contributors, http://opensimulator.org/
- * See CONTRIBUTORS.TXT for a full list of copyright holders.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * * Neither the name of the OpenSimulator Project nor the
- * names of its contributors may be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- using System;
- using System.Collections.Generic;
- namespace OpenSim.Framework.Monitoring
- {
- /// <summary>
- /// Singleton used to provide access to statistics reporters
- /// </summary>
- public class StatsManager
- {
- // Subcommand used to list other stats.
- public const string AllSubCommand = "all";
- // Subcommand used to list other stats.
- public const string ListSubCommand = "list";
- // All subcommands
- public static HashSet<string> SubCommands = new HashSet<string> { AllSubCommand, ListSubCommand };
- /// <summary>
- /// Registered stats categorized by category/container/shortname
- /// </summary>
- /// <remarks>
- /// Do not add or remove directly from this dictionary.
- /// </remarks>
- public static Dictionary<string, Dictionary<string, Dictionary<string, Stat>>> RegisteredStats
- = new Dictionary<string, Dictionary<string, Dictionary<string, Stat>>>();
- private static AssetStatsCollector assetStats;
- private static UserStatsCollector userStats;
- private static SimExtraStatsCollector simExtraStats = new SimExtraStatsCollector();
- public static AssetStatsCollector AssetStats { get { return assetStats; } }
- public static UserStatsCollector UserStats { get { return userStats; } }
- public static SimExtraStatsCollector SimExtraStats { get { return simExtraStats; } }
- public static void RegisterConsoleCommands(ICommandConsole console)
- {
- console.Commands.AddCommand(
- "General",
- false,
- "show stats",
- "show stats [list|all|<category>]",
- "Show statistical information for this server",
- "If no final argument is specified then legacy statistics information is currently shown.\n"
- + "If list is specified then statistic categories are shown.\n"
- + "If all is specified then all registered statistics are shown.\n"
- + "If a category name is specified then only statistics from that category are shown.\n"
- + "THIS STATS FACILITY IS EXPERIMENTAL AND DOES NOT YET CONTAIN ALL STATS",
- HandleShowStatsCommand);
- }
- public static void HandleShowStatsCommand(string module, string[] cmd)
- {
- ICommandConsole con = MainConsole.Instance;
- if (cmd.Length > 2)
- {
- var categoryName = cmd[2];
- if (categoryName == AllSubCommand)
- {
- foreach (var category in RegisteredStats.Values)
- {
- OutputCategoryStatsToConsole(con, category);
- }
- }
- else if (categoryName == ListSubCommand)
- {
- con.Output("Statistic categories available are:");
- foreach (string category in RegisteredStats.Keys)
- con.OutputFormat(" {0}", category);
- }
- else
- {
- Dictionary<string, Dictionary<string, Stat>> category;
- if (!RegisteredStats.TryGetValue(categoryName, out category))
- {
- con.OutputFormat("No such category as {0}", categoryName);
- }
- else
- {
- OutputCategoryStatsToConsole(con, category);
- }
- }
- }
- else
- {
- // Legacy
- con.Output(SimExtraStats.Report());
- }
- }
- private static void OutputCategoryStatsToConsole(
- ICommandConsole con, Dictionary<string, Dictionary<string, Stat>> category)
- {
- foreach (var container in category.Values)
- {
- foreach (Stat stat in container.Values)
- {
- con.Output(stat.ToConsoleString());
- }
- }
- }
- /// <summary>
- /// Start collecting statistics related to assets.
- /// Should only be called once.
- /// </summary>
- public static AssetStatsCollector StartCollectingAssetStats()
- {
- assetStats = new AssetStatsCollector();
- return assetStats;
- }
- /// <summary>
- /// Start collecting statistics related to users.
- /// Should only be called once.
- /// </summary>
- public static UserStatsCollector StartCollectingUserStats()
- {
- userStats = new UserStatsCollector();
- return userStats;
- }
- /// <summary>
- /// Registers a statistic.
- /// </summary>
- /// <param name='stat'></param>
- /// <returns></returns>
- public static bool RegisterStat(Stat stat)
- {
- Dictionary<string, Dictionary<string, Stat>> category = null, newCategory;
- Dictionary<string, Stat> container = null, newContainer;
- lock (RegisteredStats)
- {
- // Stat name is not unique across category/container/shortname key.
- // XXX: For now just return false. This is to avoid problems in regression tests where all tests
- // in a class are run in the same instance of the VM.
- if (TryGetStat(stat, out category, out container))
- return false;
- // We take a copy-on-write approach here of replacing dictionaries when keys are added or removed.
- // This means that we don't need to lock or copy them on iteration, which will be a much more
- // common operation after startup.
- if (container != null)
- newContainer = new Dictionary<string, Stat>(container);
- else
- newContainer = new Dictionary<string, Stat>();
- if (category != null)
- newCategory = new Dictionary<string, Dictionary<string, Stat>>(category);
- else
- newCategory = new Dictionary<string, Dictionary<string, Stat>>();
- newContainer[stat.ShortName] = stat;
- newCategory[stat.Container] = newContainer;
- RegisteredStats[stat.Category] = newCategory;
- }
- return true;
- }
- /// <summary>
- /// Deregister a statistic
- /// </summary>>
- /// <param name='stat'></param>
- /// <returns></returns
- public static bool DeregisterStat(Stat stat)
- {
- Dictionary<string, Dictionary<string, Stat>> category = null, newCategory;
- Dictionary<string, Stat> container = null, newContainer;
- lock (RegisteredStats)
- {
- if (!TryGetStat(stat, out category, out container))
- return false;
- newContainer = new Dictionary<string, Stat>(container);
- newContainer.Remove(stat.ShortName);
- newCategory = new Dictionary<string, Dictionary<string, Stat>>(category);
- newCategory.Remove(stat.Container);
- newCategory[stat.Container] = newContainer;
- RegisteredStats[stat.Category] = newCategory;
- return true;
- }
- }
- public static bool TryGetStats(string category, out Dictionary<string, Dictionary<string, Stat>> stats)
- {
- return RegisteredStats.TryGetValue(category, out stats);
- }
- public static bool TryGetStat(
- Stat stat,
- out Dictionary<string, Dictionary<string, Stat>> category,
- out Dictionary<string, Stat> container)
- {
- category = null;
- container = null;
- lock (RegisteredStats)
- {
- if (RegisteredStats.TryGetValue(stat.Category, out category))
- {
- if (category.TryGetValue(stat.Container, out container))
- {
- if (container.ContainsKey(stat.ShortName))
- return true;
- }
- }
- }
- return false;
- }
- }
- /// <summary>
- /// Stat type.
- /// </summary>
- /// <remarks>
- /// A push stat is one which is continually updated and so it's value can simply by read.
- /// A pull stat is one where reading the value triggers a collection method - the stat is not continually updated.
- /// </remarks>
- public enum StatType
- {
- Push,
- Pull
- }
- /// <summary>
- /// Verbosity of stat.
- /// </summary>
- /// <remarks>
- /// Info will always be displayed.
- /// </remarks>
- public enum StatVerbosity
- {
- Debug,
- Info
- }
- /// <summary>
- /// Holds individual static details
- /// </summary>
- public class Stat
- {
- /// <summary>
- /// Category of this stat (e.g. cache, scene, etc).
- /// </summary>
- public string Category { get; private set; }
- /// <summary>
- /// Containing name for this stat.
- /// FIXME: In the case of a scene, this is currently the scene name (though this leaves
- /// us with a to-be-resolved problem of non-unique region names).
- /// </summary>
- /// <value>
- /// The container.
- /// </value>
- public string Container { get; private set; }
- public StatType StatType { get; private set; }
- /// <summary>
- /// Action used to update this stat when the value is requested if it's a pull type.
- /// </summary>
- public Action<Stat> PullAction { get; private set; }
- public StatVerbosity Verbosity { get; private set; }
- public string ShortName { get; private set; }
- public string Name { get; private set; }
- public string Description { get; private set; }
- public virtual string UnitName { get; private set; }
- public virtual double Value
- {
- get
- {
- // Asking for an update here means that the updater cannot access this value without infinite recursion.
- // XXX: A slightly messy but simple solution may be to flick a flag so we can tell if this is being
- // called by the pull action and just return the value.
- if (StatType == StatType.Pull)
- PullAction(this);
- return m_value;
- }
- set
- {
- m_value = value;
- }
- }
- private double m_value;
- /// <summary>
- /// Constructor
- /// </summary>
- /// <param name='shortName'>Short name for the stat. Must not contain spaces. e.g. "LongFrames"</param>
- /// <param name='name'>Human readable name for the stat. e.g. "Long frames"</param>
- /// <param name='description'>Description of stat</param>
- /// <param name='unitName'>
- /// Unit name for the stat. Should be preceeded by a space if the unit name isn't normally appeneded immediately to the value.
- /// e.g. " frames"
- /// </param>
- /// <param name='category'>Category under which this stat should appear, e.g. "scene". Do not capitalize.</param>
- /// <param name='container'>Entity to which this stat relates. e.g. scene name if this is a per scene stat.</param>
- /// <param name='type'>Push or pull</param>
- /// <param name='pullAction'>Pull stats need an action to update the stat on request. Push stats should set null here.</param>
- /// <param name='verbosity'>Verbosity of stat. Controls whether it will appear in short stat display or only full display.</param>
- public Stat(
- string shortName,
- string name,
- string description,
- string unitName,
- string category,
- string container,
- StatType type,
- Action<Stat> pullAction,
- StatVerbosity verbosity)
- {
- if (StatsManager.SubCommands.Contains(category))
- throw new Exception(
- string.Format("Stat cannot be in category '{0}' since this is reserved for a subcommand", category));
- ShortName = shortName;
- Name = name;
- Description = description;
- UnitName = unitName;
- Category = category;
- Container = container;
- StatType = type;
- if (StatType == StatType.Push && pullAction != null)
- throw new Exception("A push stat cannot have a pull action");
- else
- PullAction = pullAction;
- Verbosity = verbosity;
- }
- public virtual string ToConsoleString()
- {
- return string.Format(
- "{0}.{1}.{2} : {3}{4}", Category, Container, ShortName, Value, UnitName);
- }
- }
- public class PercentageStat : Stat
- {
- public int Antecedent { get; set; }
- public int Consequent { get; set; }
- public override double Value
- {
- get
- {
- int c = Consequent;
- // Avoid any chance of a multi-threaded divide-by-zero
- if (c == 0)
- return 0;
- return (double)Antecedent / c * 100;
- }
- set
- {
- throw new Exception("Cannot set value on a PercentageStat");
- }
- }
- public PercentageStat(
- string shortName,
- string name,
- string description,
- string category,
- string container,
- StatType type,
- Action<Stat> pullAction,
- StatVerbosity verbosity)
- : base(shortName, name, description, "%", category, container, type, pullAction, verbosity) {}
- public override string ToConsoleString()
- {
- return string.Format(
- "{0}.{1}.{2} : {3:0.##}{4} ({5}/{6})",
- Category, Container, ShortName, Value, UnitName, Antecedent, Consequent);
- }
- }
- }
|