metrics.go

///////////////////////////////////////////////////////////////////////////////
// Copyright © 2020 xx network SEZC                                          //
//                                                                           //
// Use of this source code is governed by a license that can be found in the //
// LICENSE file                                                              //
///////////////////////////////////////////////////////////////////////////////

// Contains functionality for metric tracking on sending

package connect

import (
	"sync/atomic"
	"testing"
)

type Metric struct {
	// Active count of non-excluded errors
	// (ie errors we deem important)
	errCounter *uint64
}

// Constructor for a Metric object
func newMetric() *Metric {
	errCounter := uint64(0)
	return &Metric{
		errCounter: &errCounter,
	}
}

// Creates a metrics object with specified values. Used for testing
// purposes only
func NewMetricTesting(errCounter uint64, face interface{}) *Metric {
	// Ensure that this function is only run in testing environments
	switch face.(type) {
	case *testing.T, *testing.M, *testing.B:
		break
	default:
		panic("SetMetricsTesting() can only be used for testing.")
	}

	return &Metric{
		errCounter: &errCounter,
	}
}

// Getter for errCounter
func (m *Metric) GetErrorCounter() uint64 {
	return atomic.LoadUint64(m.errCounter)
}

// Returns a copy of Metric and resets internal state
func (m *Metric) get() *Metric {
	metricCopy := m.deepCopy()
	atomic.StoreUint64(m.errCounter, 0)
	return metricCopy
}

// Increments the error counter in a thread-safe manner
func (m *Metric) incrementErrors() {
	atomic.AddUint64(m.errCounter, 1)
}

// deepCopy creates a copy of Metric.
func (m *Metric) deepCopy() *Metric {
	newErrCounter := atomic.LoadUint64(m.errCounter)
	return &Metric{
		errCounter: &newErrCounter,
	}
}