metrics

Overview ¶

Package metrics provides setup of metrics that can be used internally to measure various application states. All metrics for the application are defined here and other applications use this package to grab the metrics and use them. This package will also report any metric that is not used in the first 10 seconds after the app has started to prevent useless metrics from existing, as all metrics should be grabbed by that time.

In a package you want to set metrics, you can do it as follows:

var addCount metrics.Int64Counter

func init() {
	addCounter = metrics.Get.Int64("petstore/server/AddPets/requests")
}
...

func (s *Server) AddPets(ctx context.Context, req *pb.AddPetsReq) (*pb.AddpetsResp, error) {
	...
	// Do this if you have multiple changes that don't require special labels per update.
	metrics.Meter.RecordBatch(ctx, nil, addCounter.Measure(ctx, 1))
	// Do this if you only need to make one change or need special labels.
	addCounter.Add(ctx, 1, attribute.String("label", "value")
	...
}

To cause metrics to be exported package main():

func main() {
	...
	stop, err := metrics.Start(ctx, metrics.OTELGRPC{Addr: "ip:port"})
	if err != nil {
		log.Fatal(err)
	}
	defer stop()
	...
}