Class Statsd

Inheritance
System.Object
Statsd
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace:StatsN
Assembly:cs.temp.dll.dll
Syntax
public class Statsd : IStatsd, IDisposable

Constructors

| Improve this Doc

Statsd(StatsdOptions, BaseCommunicationProvider)

Create a statsd client

Declaration
public Statsd(StatsdOptions options, BaseCommunicationProvider provider = null)
Parameters
Type Name Description
StatsdOptions options

client options

BaseCommunicationProvider provider

provider, defaults to udp if none is passed

Methods

| Improve this Doc

CountAsync(String, Int64)

Simple Counter

Declaration
public Task CountAsync(string name, long count = 1L)
Parameters
Type Name Description
System.String name
System.Int64 count
Returns
Type Description
System.Threading.Tasks.Task
Implements
| Improve this Doc

Dispose()

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()
| Improve this Doc

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
| Improve this Doc

GaugeAsync(String, Int64)

arbitrary values, which can be recorded.

Declaration
public Task GaugeAsync(string name, long value)
Parameters
Type Name Description
System.String name
System.Int64 value
Returns
Type Description
System.Threading.Tasks.Task
Implements
| Improve this Doc

GaugeDeltaAsync(String, Int64)

Add or remove from gauge instead of setting

Declaration
public Task GaugeDeltaAsync(string name, long value)
Parameters
Type Name Description
System.String name
System.Int64 value
Returns
Type Description
System.Threading.Tasks.Task
Implements
| Improve this Doc

New(StatsdOptions)

Create a new Statsd client. Defaults to Udp

Declaration
public static Statsd New(StatsdOptions options)
Parameters
Type Name Description
StatsdOptions options

client options
Returns
Type Description
Statsd
| Improve this Doc

New(Action<StatsdOptions>)

Create a new Statsd client. Defaults to Udp

Declaration
public static Statsd New(Action<StatsdOptions> configure)
Parameters
Type Name Description
System.Action<T><StatsdOptions> configure

configuration block
Returns
Type Description
Statsd
| Improve this Doc

New<T>(StatsdOptions)

Create a new Statsd client

Declaration
public static Statsd New<T>(StatsdOptions options)where T : BaseCommunicationProvider, new ()
Parameters
Type Name Description
StatsdOptions options

client options
Returns
Type Description
Statsd
Type Parameters
Name Description
T Statsd client to use
| Improve this Doc

New<T>(Action<StatsdOptions>)

Create a new Statsd client

Declaration
public static Statsd New<T>(Action<StatsdOptions> configure)where T : BaseCommunicationProvider, new ()
Parameters
Type Name Description
System.Action<T><StatsdOptions> configure

configuration block
Returns
Type Description
Statsd
Type Parameters
Name Description
T Statsd client to use
| Improve this Doc

SetAsync(String, Int64)

StatsD supports counting unique occurences of events between flushes, using a Set to store all occuring events

Declaration
public Task SetAsync(string name, long value)
Parameters
Type Name Description
System.String name
System.Int64 value
Returns
Type Description
System.Threading.Tasks.Task
Implements
| Improve this Doc

TimingAsync(String, Action)

How long something takes to complete. StatsD figures out percentiles, average (mean), standard deviation, sum, lower and upper bounds for the flush interval

Declaration
public Task TimingAsync(string name, Action actionToTime)
Parameters
Type Name Description
System.String name
System.Action actionToTime

action to instrument
Returns
Type Description
System.Threading.Tasks.Task
Implements
| Improve this Doc

TimingAsync(String, Int64)

How long something takes to complete. StatsD figures out percentiles, average (mean), standard deviation, sum, lower and upper bounds for the flush interval

Declaration
public Task TimingAsync(string name, long milliseconds)
Parameters
Type Name Description
System.String name
System.Int64 milliseconds

time to log in ms
Returns
Type Description
System.Threading.Tasks.Task
Implements