mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-01-07 23:02:15 +02:00
91091b44eb
* Add comments on needed filed alignment Add comment about alignment requirements to all struct fields who's values are passed to 64-bit atomic operations. Update any struct's field ordering if one or more of those fields has alignment requirements to support 64-bit atomic operations. * Add 64-bit alignment tests Most `struct` that have field alignment requirements are now statically validated prior to testing. The only `struct`s not validated that have these requirements are ones defined in tests themselves where multiple `TestMain` functions would be needed to test them. Given the fields are already identified with comments specifying the alignment requirements and they are in the test themselves, this seems like an OK omission. Co-authored-by: Liz Fong-Jones <elizabeth@ctyalcove.org>
144 lines
3.9 KiB
Go
144 lines
3.9 KiB
Go
// Copyright 2019, OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package metric_test
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/api/core"
|
|
"go.opentelemetry.io/otel/api/key"
|
|
"go.opentelemetry.io/otel/api/metric"
|
|
export "go.opentelemetry.io/otel/sdk/export/metric"
|
|
"go.opentelemetry.io/otel/sdk/export/metric/aggregator"
|
|
sdk "go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric/aggregator/gauge"
|
|
)
|
|
|
|
type monotoneBatcher struct {
|
|
// currentValue needs to be aligned for 64-bit atomic operations.
|
|
currentValue *core.Number
|
|
collections int
|
|
currentTime *time.Time
|
|
|
|
t *testing.T
|
|
}
|
|
|
|
func (*monotoneBatcher) AggregatorFor(*export.Descriptor) export.Aggregator {
|
|
return gauge.New()
|
|
}
|
|
|
|
func (*monotoneBatcher) CheckpointSet() export.CheckpointSet {
|
|
return nil
|
|
}
|
|
|
|
func (*monotoneBatcher) FinishedCollection() {
|
|
}
|
|
|
|
func (m *monotoneBatcher) Process(_ context.Context, record export.Record) error {
|
|
require.Equal(m.t, "my.gauge.name", record.Descriptor().Name())
|
|
require.Equal(m.t, 1, record.Labels().Len())
|
|
require.Equal(m.t, "a", string(record.Labels().Ordered()[0].Key))
|
|
require.Equal(m.t, "b", record.Labels().Ordered()[0].Value.Emit())
|
|
|
|
gauge := record.Aggregator().(*gauge.Aggregator)
|
|
val, ts, err := gauge.LastValue()
|
|
require.Nil(m.t, err)
|
|
|
|
m.currentValue = &val
|
|
m.currentTime = &ts
|
|
m.collections++
|
|
return nil
|
|
}
|
|
|
|
func TestMonotoneGauge(t *testing.T) {
|
|
ctx := context.Background()
|
|
batcher := &monotoneBatcher{
|
|
t: t,
|
|
}
|
|
sdk := sdk.New(batcher, sdk.NewDefaultLabelEncoder())
|
|
|
|
sdk.SetErrorHandler(func(error) { t.Fatal("Unexpected") })
|
|
|
|
gauge := sdk.NewInt64Gauge("my.gauge.name", metric.WithMonotonic(true))
|
|
|
|
handle := gauge.Bind(sdk.Labels(key.String("a", "b")))
|
|
|
|
require.Nil(t, batcher.currentTime)
|
|
require.Nil(t, batcher.currentValue)
|
|
|
|
before := time.Now()
|
|
|
|
handle.Set(ctx, 1)
|
|
|
|
// Until collection, expect nil.
|
|
require.Nil(t, batcher.currentTime)
|
|
require.Nil(t, batcher.currentValue)
|
|
|
|
sdk.Collect(ctx)
|
|
|
|
require.NotNil(t, batcher.currentValue)
|
|
require.Equal(t, core.NewInt64Number(1), *batcher.currentValue)
|
|
require.True(t, before.Before(*batcher.currentTime))
|
|
|
|
before = *batcher.currentTime
|
|
|
|
// Collect would ordinarily flush the record, except we're using a handle.
|
|
sdk.Collect(ctx)
|
|
|
|
require.Equal(t, 2, batcher.collections)
|
|
|
|
// Increase the value to 2.
|
|
handle.Set(ctx, 2)
|
|
|
|
sdk.Collect(ctx)
|
|
|
|
require.Equal(t, 3, batcher.collections)
|
|
require.Equal(t, core.NewInt64Number(2), *batcher.currentValue)
|
|
require.True(t, before.Before(*batcher.currentTime))
|
|
|
|
before = *batcher.currentTime
|
|
|
|
sdk.Collect(ctx)
|
|
require.Equal(t, 4, batcher.collections)
|
|
|
|
// Try to lower the value to 1, it will fail.
|
|
var err error
|
|
sdk.SetErrorHandler(func(sdkErr error) {
|
|
err = sdkErr
|
|
})
|
|
handle.Set(ctx, 1)
|
|
require.Equal(t, aggregator.ErrNonMonotoneInput, err)
|
|
sdk.SetErrorHandler(func(error) { t.Fatal("Unexpected") })
|
|
|
|
sdk.Collect(ctx)
|
|
|
|
// The value and timestamp are both unmodified
|
|
require.Equal(t, 5, batcher.collections)
|
|
require.Equal(t, core.NewInt64Number(2), *batcher.currentValue)
|
|
require.Equal(t, before, *batcher.currentTime)
|
|
|
|
// Update with the same value, update the timestamp.
|
|
handle.Set(ctx, 2)
|
|
sdk.Collect(ctx)
|
|
|
|
require.Equal(t, 6, batcher.collections)
|
|
require.Equal(t, core.NewInt64Number(2), *batcher.currentValue)
|
|
require.True(t, before.Before(*batcher.currentTime))
|
|
}
|