Skip to content
ApplicationMetrics provides interfaces and classes to allow simple logging of metric and instrumentation events from a client application
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ApplicationMetrics.UnitTests
ApplicationMetrics
Referenced Libraries
Resources
.gitattributes
.gitignore
ApplicationMetrics.sln
LICENSE
NOTICE
README.md

README.md

ApplicationMetrics

ApplicationMetrics provides simple interfaces and classes to allow capturing metric and instrumentation information from a client application. It was designed with the following goals...

  1. Provide interfaces which can be injected into client classes, and provide simple methods for logging metrics from these classes.
  2. To ensure that details of how the metrics are stored and displayed is hidden behind the interfaces
  3. To provide a simple mechanism of viewing metrics through the Windows Performance Monitor (i.e. simpler than that provided by the .NET PerformanceCounter and CounterCreationData classes)
  4. To provide additional implementation of metric loggers and viewers for files, console, and relational databases, plus base classes to allow consumers to easily provide their own implementations of metric loggers and viewers.

Getting Started

1) Defining Metrics

Metrics are defined, by deriving from the CountMetric, AmountMetric, StatusMetric, and IntervalMetric classes. The difference between these metric types is outlined below...

Class Description
CountMetric Used when you need to record the number of instances of an event and where the events increments by 1 each time (e.g. number of disk read operations, number of messages sent to a remote system, number of cache hits)
AmountMetric Used to record the size of an entity associated with an event (e.g. the size of a message sent to a remote system)
StatusMetric Used to record the size of an entity at a specific point in time (e.g. total amount of free memory)
IntervalMetric Used to record the time taken for an event to complete (e.g. total time taken to send a message to a remote system)

In this sample case ApplicationMetrics is used to capture instrumentation from a class which sends a message to a remote location. We would define the following 3 metrics...

class MessageSent : CountMetric
{
    public MessageSent()
    {
        base.name = "MessageSent";
        base.description = "The number of messages sent";
    }
}

class MessageSize : AmountMetric
{
    public MessageSize(long messageSize)
    {
        base.name = "MessageSize";
        base.description = "The size of a sent message";
        base.amount = messageSize;
    }
}

class MessageSendTime : IntervalMetric
{
    public MessageSendTime()
    {
        base.name = "MessageSendTime";
        base.description = "The time taken to send a message";
    }
}
2) Using the IMetricLogger interface

The IMetricLogger interface should be injected into the client class. The example below shows our message sending class, with an instance of IMetricLogger used to log the above metrics when a message is sent.

public class MessageSender
{
    private IMetricLogger metricLogger;

    public MessageSender(IMetricLogger metricLogger)
    {
        this.metricLogger = metricLogger;
    }

    public void Send(String message)
    {
        metricLogger.Begin(new MessageSendTime());

        // Call private method to perform the send
        try
        {
            SendMessage(message);
        }
        catch (Exception e)
        {
            metricLogger.CancelBegin(new MessageSendTime());
            throw e;
        }

        metricLogger.End(new MessageSendTime());
        metricLogger.Increment(new MessageSent());
        metricLogger.Add(new MessageSize(message.Length));
    }

The MessageSender class could be instantiated using a FileMetricLogger with the below statements...

FileMetricLogger metricLogger  = new FileMetricLogger('|', @"C:\Test\MessageSenderMetrics.log", 1000, true);
MessageSender testMessageSender = new MessageSender(metricLogger);
3) Using the IMetricAggregateLogger interface

Classes that implement IMetricAggregateLogger (ConsoleMetricLogger and PerformanceCounterMetricLogger) let you define and log aggregates of individual metrics. The example client code below shows how to define some aggregates for the above metrics...

static void Main(string[] args)
{
    LoopingWorkerThreadBufferProcessor bufferProcessor = new LoopingWorkerThreadBufferProcessor(5000, false);
    ConsoleMetricLogger metricLogger = new ConsoleMetricLogger(bufferProcessor, true);

    // Define a metric aggregate to record the average size of sent messages (total message size / number of messages sent)
    metricLogger.DefineMetricAggregate(new MessageSize(0), new MessageSent(), "AverageMessageSize", "The average size of sent messages");

    // Define a metric aggregate to record the number of messages sent per second (number of messages sent / number of seconds of runtime)
    metricLogger.DefineMetricAggregate(new MessageSent(), TimeUnit.Second, "MessagesSentPerSecond", "The number of messages sent per second");
}
4) Viewing the metrics

When started, the ConsoleMetricLogger will produce output similar to the following...

---------------------------------------------------
-- Application metrics as of 2015-06-16 13:01:11 --
---------------------------------------------------
MessageSent: 207
MessageSize: 1223510
MessageSendTime: 12834
AverageMessageSize: 5910.676328502415
MessagesSentPerSecond: 2.41545893719806
Links

Full documentation for the project...
http://www.alastairwyse.net/methodinvocationremoting/application-metrics.html

A detailed sample implementation...
http://www.alastairwyse.net/methodinvocationremoting/sample-application-5.html

Code documentation...
http://www.alastairwyse.net/methodinvocationremoting/ndoc/~ApplicationMetrics.html

Notes
  • After opening the solution in Visual Studio, the referenced NuGet packages should be restored using the 'Restore' button in the 'Manage NuGet Packages' window.

Release History

Version Changes
1.5.0.0 MetricLoggerBuffer class updated to implement IDisposable, and unhook buffer processed event handlers on dispose.
Classes deriving from MetricLoggerBuffer updated to implement IDisposable.
1.4.0.0 Initial version forked from the Method Invocation Remoting project.
You can’t perform that action at this time.