StatsDHelper

Simple wrapper around statsd-csharp-client which adds a prefix based on the hosts Fully Qualified Domain Name and a configurable application name prefix.

So for a metric named api.responses.httpstatus.500 coming from a host named servername.example.com with a configured application name of api.

The emitted metric will be:

com.example.servername.api.responses.httpstatus.500

The helper class is designed to fail silently in the event of misconfiguration (look for warnings in your build log) and to be used similarly to something like log4net.

Quick Start

Configuration

The StatsDHelper.Configure method need to be called before calling StatsDHelper.Instance. All 3 of the following properties are required.

var statsDHelperConfig = new StatsDHelperConfig()
{
    ApplicationName = "sampleapi",
    StatsDServerPort = 8125,
    StatsDServerHost = "my.statsd.server"
};
StatsDHelper.Configure(statsDHelperConfig);

Example Usage:

    public class FooService
    {
        private readonly IStatsDHelper _statsDHelper;
        
        public FooService(){
            var statsDHelperConfig = new StatsDHelperConfig()
            {
                ApplicationName = "sampleapi",
                StatsDServerPort = 8125,
                StatsDServerHost = "my.statsd.server"
            };
            StatsDHelper.Configure(statsDHelperConfig);        
        
            _statsDHelper = StatsDHelper.StatsDHelper.Instance;
        }
        
        public void CalculateFoo(int a, int b){
            _statsDHelper.LogCount("calculatefoo");
        }

        public List<FooWidget> GetFooWidgets(){
            var repository = new FooRepository();

            using(_statsDHelper.LogTiming("foorepository.getfoowidgets.latency") {
                return repository.GetFooWidgets();
            }
        }
    }