A metrics output system for collecting data for analytics.
Switch branches/tags
Nothing to show
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.
Examples
Properties
Tests
.editorconfig
.gitignore
IMetricsEmitter.cs
LICENSE
Metric.cs
Metrics.cs
Metrics.csproj
Metrics.nuspec
Metrics.sln
README.md

README.md

Metrics

This is a simple metrics system for collecting data.

Requirements

To use the metrics system you will need to implement the IMetricsEmitter interface.

IMetricsEmitter

A metrics emitter emit function has three parameters:

  • properties: This is a dictionary of the properties for the current batch of metrics.

  • metrics: An array of all current cached metrics.

  • metricsIndex: The index of the last current valid metric (Note: it is the responsibility of the emitter to remove the invalid metrics).

    public class ExampleEmitter : IMetricsEmitter { public Emit(IDictionary<string, object> properties, Metric[] metrics, int metricsIndex) { // Implement. } }

Metrics

When initalizing the metrics system you will have to pass it an IMetricsEmitter and an int defining the batch size.

var metrics = new Metrics(new ExampleEmitter(), 1);

metrics.Entry("Entry", "Data");

Metric

A metric is a struct that is used by all metrics.

  • Name: A string used for the name given to the metric.
  • TimeStamp: DateTime set to the time that the metric was emitted.
  • Type: A string used for indicating the type of metric.
  • Data: An object that is the data to be sent with the metric.

Note: The type of a metric is wrapped by the API. They are set by the function call itself. These types are string, float, int, inc (see 'Increment' below) or event (see 'Event' below)

Usage

The metrics system has three different metrics that it can emit:

Entry

The Entry function for sending data as a string, int or a float.

metrics.Entry("Entry", "Data");
metrics.Entry("Entry", 1);
metrics.Entry("Entry", 1.0f);

Increment

The Increment function is used to emit an increment style Metric.

metrics.Inc("Name");

Increment sets the metric type to 'inc'

Event

Designed to be a used for recording the occurances of events.

	metrics.Event("Name");

Event sets the metric type to 'event'.

Flush

Emits any metrics that are currently in the batch queue.

    metrics.Flush();

Examples

Within this repository there are several simple examples of using the metrics system with different emitters.

Example 1

A basic example of the metric system with a simple implementation of the IMetricEmitter interface that writes metrics to a file.

Example 2

This example implements a IMetricsEmitter that emits the metrics via http post.

Example 3

Example 3 is an example of using the built in batching system in the metrics system.

Unity Example

An example of running the metrics system under Unity3D using the Unity3D method of http post.