Files
tasks/common/metrics/config_test.go
Alex ShtinandGitHub 8e8f1b0f7c Remove license header from every file (#7689)
## What changed?
<!-- Describe what has changed in this PR -->
Remove license header from every file. Because it is really hard to
follow in this PR here is the summary:
1. License header is removed from all `.go` and `.proto` files
:fireworks::fireworks:🎆.
2. `LICENSE` file in the root directory has only Temporal and Uber
copyrights.
3. 5 other `LICENSE` files added to the packages which have copyrights
different from Temporal and Uber: Datadog, Xargin, "Mat Ryer, Tyler
Bunnell and contributors".
4. `license_file` flag is removed from all code generation tools.
5. `copyright_file` flag is removed from `go:generate mockgen`
directive.
6. All copyright related targets are removed from `Makefile`.
7. Updated Temporal copyright year to 2025 everywhere.

## Why?
<!-- Tell your future self why have you made these changes -->
I double checked with legal department that it is not needed to have
license header in every file. One file per repo is enough. I put all
copyrights to the root `LICENSE` file and removed header from all other
files. Also updated tools and `Makefile`.
2025-05-01 18:50:21 -07:00

182 lines
4.0 KiB
Go

package metrics
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
"github.com/uber-go/tally/v4"
"go.temporal.io/server/common/log"
"go.uber.org/mock/gomock"
)
type MetricsSuite struct {
*require.Assertions
suite.Suite
controller *gomock.Controller
}
func TestMetricsSuite(t *testing.T) {
suite.Run(t, new(MetricsSuite))
}
func (s *MetricsSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.controller = gomock.NewController(s.T())
}
func (s *MetricsSuite) TestStatsd() {
statsd := &StatsdConfig{
HostPort: "127.0.0.1:8125",
Prefix: "testStatsd",
}
config := new(Config)
config.Statsd = statsd
scope := NewScope(log.NewNoopLogger(), config)
s.NotNil(scope)
}
func (s *MetricsSuite) TestPrometheus() {
prom := &PrometheusConfig{
OnError: "panic",
TimerType: "histogram",
ListenAddress: "127.0.0.1:0",
}
config := new(Config)
config.Prometheus = prom
scope := NewScope(log.NewNoopLogger(), config)
s.NotNil(scope)
}
func (s *MetricsSuite) TestPrometheusWithSanitizeOptions() {
validChars := &ValidCharacters{
Ranges: []SanitizeRange{
{
StartRange: "a",
EndRange: "z",
},
{
StartRange: "A",
EndRange: "Z",
},
{
StartRange: "0",
EndRange: "9",
},
},
SafeCharacters: "-",
}
prom := &PrometheusConfig{
OnError: "panic",
TimerType: "histogram",
ListenAddress: "127.0.0.1:0",
SanitizeOptions: &SanitizeOptions{
NameCharacters: validChars,
KeyCharacters: validChars,
ValueCharacters: validChars,
ReplacementCharacter: "_",
},
}
config := new(Config)
config.Prometheus = prom
scope := NewScope(log.NewNoopLogger(), config)
s.NotNil(scope)
}
func (s *MetricsSuite) TestNoop() {
config := &Config{}
scope := NewScope(log.NewNoopLogger(), config)
s.Equal(tally.NoopScope, scope)
}
func (s *MetricsSuite) TestSetDefaultPerUnitHistogramBoundaries() {
type histogramTest struct {
input map[string][]float64
expectResult map[string][]float64
}
testCases := []histogramTest{
{
input: nil,
expectResult: map[string][]float64{
Dimensionless: defaultPerUnitHistogramBoundaries[Dimensionless],
Milliseconds: defaultPerUnitHistogramBoundaries[Milliseconds],
Seconds: {0.001, 0.002, 0.005, 0.010, 0.020, 0.050, 0.100, 0.200, 0.500, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1_000},
Bytes: defaultPerUnitHistogramBoundaries[Bytes],
},
},
{
input: map[string][]float64{
UnitNameDimensionless: {1},
UnitNameMilliseconds: {10, 1000, 2000},
"notDefine": {1},
},
expectResult: map[string][]float64{
Dimensionless: {1},
Milliseconds: {10, 1000, 2000},
Seconds: {0.01, 1, 2},
Bytes: defaultPerUnitHistogramBoundaries[Bytes],
},
},
}
for _, test := range testCases {
config := &ClientConfig{PerUnitHistogramBoundaries: test.input}
setDefaultPerUnitHistogramBoundaries(config)
s.Equal(test.expectResult, config.PerUnitHistogramBoundaries)
}
}
func TestMetricsHandlerFromConfig(t *testing.T) {
t.Parallel()
logger := log.NewTestLogger()
for _, c := range []struct {
name string
cfg *Config
expectedType interface{}
}{
{
name: "nil config",
cfg: nil,
expectedType: &noopMetricsHandler{},
},
{
name: "tally",
cfg: &Config{
Prometheus: &PrometheusConfig{
Framework: FrameworkTally,
ListenAddress: "localhost:0",
},
},
expectedType: &tallyMetricsHandler{},
},
{
name: "opentelemetry",
cfg: &Config{
Prometheus: &PrometheusConfig{
Framework: FrameworkOpentelemetry,
ListenAddress: "localhost:0",
},
},
expectedType: &otelMetricsHandler{},
},
} {
c := c
t.Run(c.name, func(t *testing.T) {
t.Parallel()
handler, err := MetricsHandlerFromConfig(logger, c.cfg)
require.NoError(t, err)
t.Cleanup(func() {
handler.Stop(logger)
})
assert.IsType(t, c.expectedType, handler)
})
}
}