Statful Client for golang

Statful client for golang written in go. This client is intended to gather metrics and send them to Statful.

Table of Contents

• Supported Versions of Golang
• Quick Start
• Reference
  • Global Configuration
  • Methods
• Examples
  • UDP Configuration
  • HTTP Configuration
  • Disabling Auto Flush
  • Buffer Configuration
  • Event Sender Configuration
• Authors
• License

Supported Versions of Golang

Statful Client version	Tested golang versions
0.16.0	1.15
0.15.0	1.15

Quick Start

Two examples are available in the examples folder. One of an http server and one of a simple metric. You can use them as guideline on how to setup a golang client on your own project.

Reference

The following section presents a detailed reference of the available options to take full advantage of Statful.

Global Configuration

Below you can find the information on the custom options to set up the configurations parameters.

Option	Description	Type	Default	Required
DisableAutoFlush	Defines if metrics should be flushed synchronously. FlushSize and FlushInterval attributes are disabled and Flush() or FlushError() functions should be called instead.	boolean	false	NO
DryRun	Defines if metrics should be output to the logger instead of being sent to Statful (useful for testing/debugging purposes).	boolean	false	NO
FlushSize	Defines the maximum buffer size before performing a flush, in bytes.	number	1000	NO
GlobalTags	Object for setting the global tags.	object	{}	NO
Url	Defines the url where the metrics are sent.	string	none	NO
token	Defines the token used to match incoming data to Statful. It can only be set inside api.	string	none	YES
timeout	Defines the timeout for the transport layers in milliseconds. It can only be set inside api.	number	2000	NO

Methods

The methods for non-aggregated metrics receive a metric name and value as arguments and send a counter, a gauge, a timer or a custom metric.

// Non-Aggregated Metrics
- statful.Counter("myCounter", 1.0, statful.Tags{"foo "bar"});
- statful.Gauge("myGauge", 1, statful.Tags{"foo "bar"});
- statful.Timer("myTimer", 1.0, statful.Tags{"foo "bar"});
- statful.Put("myCustomMetric", 200, statful.Tags{"foo "bar"}, time.Now().Unix(), statful.Aggregations{AggAvg: struct{}{}}, statful.Freq30s, statful.WithUser("user-uuid"));

// Aggregated Metrics
- statful.CounterAggregated("myCounter", 1.0, statful.Tags{"foo "bar"}, statful.Aggregations{AggAvg: struct{}{}}, statful.Freq30s);
- statful.GaugeAggregated("myGauge", 1, statful.Tags{"foo "bar"}, statful.Aggregations{AggAvg: struct{}{}}, statful.Freq30s);
- statful.TimerAggregated("myTimer", 1.0, statful.Tags{"foo "bar"}, statful.Aggregations{AggAvg: struct{}{}}, statful.Freq30s);
- statful.PutAggregated("myCustomMetric", 200, statful.Tags{"foo "bar"}, time.Now().Unix(), statful.Aggregations{AggAvg: struct{}{}}, statful.Freq30s, statful.WithUser("user-uuid"));

Examples

Here you can find some useful usage examples of the Statful’s golang Client.

UDP Configuration

Create a simple UDP configuration for the client.

statful.Statful{
    Sender: &statful.ProxyMetricsSender{
        Client: &statful.UdpClient{
            Address: "localhost:1234",
        },
    },
    GlobalTags: statful.Tags{"client": "golang"},
    DryRun:     false,
}

HTTP Configuration

Create a simple HTTP API configuration for the client.

statful.New(
    statful.Configuration{
        DryRun: false,
        FlushSize: 1000,

        Sender: &statful.HttpSender{
            Http:     &http.Client{},
            Url:      "https://api.statful.com",
            Token:    "12345678-09ab-cdef-1234-567890abcdef",
        },

        Logger: log.New(os.Stderr, "", log.LstdFlags),
        Tags: statful.Tags{"client": "golang"},
    }
)

Disabling Auto Flush

Create an HTTP API configuration that prevents flushing asynchronously.

statful.New(
    statful.Configuration{
        DisableAutoFlush: true,
        DryRun: false,

        Sender: &statful.HttpSender{
            Http:     &http.Client{},
            Url:      "https://api.statful.com",
            Token:    "12345678-09ab-cdef-1234-567890abcdef",
        },

        Logger: log.New(os.Stderr, "", log.LstdFlags),
        Tags: statful.Tags{"client": "golang"},
    }
)

Buffer Configuration

Create a simple Metrics Sender that buffers metrics before sending.

statful.New(
    statful.Configuration{
        DryRun: false,
        FlushSize: 1000,

        Sender: &statful.HttpSender{
            Http:     &http.Client{},
            Url:      "https://api.statful.com",
            Token:    "12345678-09ab-cdef-1234-567890abcdef",
        },

        Logger: log.New(os.Stderr, "", log.LstdFlags),
        Tags: statful.Tags{"client": "golang"},
    }
)

Event Sender Configuration

To send event payload (JSON) you may configure event sender in your client.

statful.New(
    statful.Configuration{
        DryRun: false,

        Sender: &statful.HttpSender{
            Http:     &http.Client{},
            Url:      "https://api.statful.com",
            Token:    "12345678-09ab-cdef-1234-567890abcdef",
        },
        Logger: log.New(os.Stderr, "", log.LstdFlags),
    }
)

Authors

Statful

License

Statful Golang Client is available under the MIT license. See the LICENSE file for more information.