ipfs-cluster/observations/metrics.go

package observations

import (
	"go.opencensus.io/stats"
	"go.opencensus.io/stats/view"
	"go.opencensus.io/tag"

	logging "github.com/ipfs/go-log"
)

var logger = logging.Logger("observations")

var (
	// taken from ocgrpc (https://github.com/census-instrumentation/opencensus-go/blob/master/plugin/ocgrpc/stats_common.go)
	latencyDistribution = view.Distribution(0, 0.01, 0.05, 0.1, 0.3, 0.6, 0.8, 1, 2, 3, 4, 5, 6, 8, 10, 13, 16, 20, 25, 30, 40, 50, 65, 80, 100, 130, 160, 200, 250, 300, 400, 500, 650, 800, 1000, 2000, 5000, 10000, 20000, 50000, 100000)

	bytesDistribution = view.Distribution(0, 24, 32, 64, 128, 256, 512, 1024, 2048, 4096, 16384, 65536, 262144, 1048576)
)

// opencensus attributes
var (
	ClientIPAttribute = "http.client.ip"
)

// opencensus keys
var (
	HostKey = makeKey("host")
)

// opencensus metrics
var (
	// PinCountMetric counts the number of pins ipfs-cluster is tracking.
	PinCountMetric = stats.Int64("cluster/pin_count", "Number of pins", stats.UnitDimensionless)
	// TrackerPinCountMetric counts the number of pins the local peer is tracking.
	TrackerPinCountMetric = stats.Int64("pintracker/pin_count", "Number of pins", stats.UnitDimensionless)
	// PeerCountMetric counts the number of ipfs-cluster peers are currently in the cluster.
	PeerCountMetric = stats.Int64("cluster/peer_count", "Number of cluster peers", stats.UnitDimensionless)
)

// opencensus views, which is just the aggregation of the metrics
var (
	PinCountView = &view.View{
		Measure:     PinCountMetric,
		Aggregation: view.Sum(),
	}

	TrackerPinCountView = &view.View{
		Measure:     TrackerPinCountMetric,
		TagKeys:     []tag.Key{HostKey},
		Aggregation: view.Sum(),
	}

	PeerCountView = &view.View{
		Measure:     PeerCountMetric,
		TagKeys:     []tag.Key{HostKey},
		Aggregation: view.Count(),
	}

	DefaultViews = []*view.View{
		PinCountView,
		TrackerPinCountView,
		PeerCountView,
	}
)

func makeKey(name string) tag.Key {
	key, err := tag.NewKey(name)
	if err != nil {
		logger.Fatal(err)
	}
	return key
}