Categorygithub.com/neurio/cloudmetrics
modulepackage
1.0.0
Repository: https://github.com/neurio/cloudmetrics.git
Documentation: pkg.go.dev

# README

cloudmetrics

CircleCI

This is a reporter for the go-metrics that will posts metrics to CloudWatch.

Usage

import "github.com/neurio/cloudmetrics"

go cloudmetrics.Publish(metrics.DefaultRegistry,
    "/sample/", // namespace
)

Configuration

cloudmetrics supports a number of configuration options

import "github.com/neurio/cloudmetrics"

go cloudmetrics.Publish(metrics.DefaultRegistry,
    "/sample/",                                      // namespace
    cloudmetrics.Dimensions("k1", "v1", "k2", "v2"), // allows for custom dimensions
    cloudmetrics.Interval(time.Minutes * 5),         // custom interval
    cloudmetrics.Context(context.Background()),      // enables graceful shutdown via golang.org/x/net/context 
    cloudmetrics.Percentiles([]float64{.5, .99}),    // customize percentiles for histograms and timers 
)

# Functions

Client allows for user provided *cloudwatch.Cloudwatch instance.
Context allows a context to be specified.
Debug writes additional data to the writer specified.
Dimensions allows for user specified dimensiosn to be added to the post.
Interval allows for a custom posting interval; by default, the interval is every 1 minute.
Percentiles allows the reported percentiles for Histogram and Timer metrics to be customized.
Publish is the main entry point to publish metrics on a recurring basis to CloudWatch.

# Structs

No description provided by the author

# Interfaces

CloudWatch is an interface for *cloudwatch.CloudWatch that clearly identifies the functions used by cloudmetrics.

# Type aliases

No description provided by the author