-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add WithReader and WithResource Options (#2905)
* Add WithReader and WithResource Options * Run lint * Update WithReader fn signature based on feedback * crosslink * Remove zero-len check in unify * Restrict build to Go > 1.16
- Loading branch information
Showing
6 changed files
with
311 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| // Copyright The 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. | ||
|
|
||
| //go:build go1.17 | ||
| // +build go1.17 | ||
|
|
||
| package metric | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "go.opentelemetry.io/otel/sdk/metric/export" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| ) | ||
|
|
||
| type reader struct { | ||
| producer producer | ||
| collectFunc func(context.Context) (export.Metrics, error) | ||
| forceFlushFunc func(context.Context) error | ||
| shutdownFunc func(context.Context) error | ||
| } | ||
|
|
||
| var _ Reader = (*reader)(nil) | ||
|
|
||
| func (r *reader) register(p producer) { r.producer = p } | ||
| func (r *reader) Collect(ctx context.Context) (export.Metrics, error) { return r.collectFunc(ctx) } | ||
| func (r *reader) ForceFlush(ctx context.Context) error { return r.forceFlushFunc(ctx) } | ||
| func (r *reader) Shutdown(ctx context.Context) error { return r.shutdownFunc(ctx) } | ||
|
|
||
| func TestConfigReaderSignalsEmpty(t *testing.T) { | ||
| f, s := config{}.readerSignals() | ||
|
|
||
| require.NotNil(t, f) | ||
| require.NotNil(t, s) | ||
|
|
||
| ctx := context.Background() | ||
| assert.Nil(t, f(ctx)) | ||
| assert.Nil(t, s(ctx)) | ||
| assert.ErrorIs(t, s(ctx), ErrReaderShutdown) | ||
| } | ||
|
|
||
| func TestConfigReaderSignalsForwarded(t *testing.T) { | ||
| var flush, sdown int | ||
| r := &reader{ | ||
| forceFlushFunc: func(ctx context.Context) error { | ||
| flush++ | ||
| return nil | ||
| }, | ||
| shutdownFunc: func(ctx context.Context) error { | ||
| sdown++ | ||
| return nil | ||
| }, | ||
| } | ||
| c := newConfig([]Option{WithReader(r)}) | ||
| f, s := c.readerSignals() | ||
|
|
||
| require.NotNil(t, f) | ||
| require.NotNil(t, s) | ||
|
|
||
| ctx := context.Background() | ||
| assert.NoError(t, f(ctx)) | ||
| assert.NoError(t, f(ctx)) | ||
| assert.NoError(t, s(ctx)) | ||
| assert.ErrorIs(t, s(ctx), ErrReaderShutdown) | ||
|
|
||
| assert.Equal(t, 2, flush, "flush not called 2 times") | ||
| assert.Equal(t, 1, sdown, "shutdown not called 1 time") | ||
| } | ||
|
|
||
| func TestConfigReaderSignalsForwardedErrors(t *testing.T) { | ||
| r := &reader{ | ||
| forceFlushFunc: func(ctx context.Context) error { return assert.AnError }, | ||
| shutdownFunc: func(ctx context.Context) error { return assert.AnError }, | ||
| } | ||
| c := newConfig([]Option{WithReader(r)}) | ||
| f, s := c.readerSignals() | ||
|
|
||
| require.NotNil(t, f) | ||
| require.NotNil(t, s) | ||
|
|
||
| ctx := context.Background() | ||
| assert.ErrorIs(t, f(ctx), assert.AnError) | ||
| assert.ErrorIs(t, s(ctx), assert.AnError) | ||
| assert.ErrorIs(t, s(ctx), ErrReaderShutdown) | ||
| } | ||
|
|
||
| func TestUnifyMultiError(t *testing.T) { | ||
| f := func(context.Context) error { return assert.AnError } | ||
| funcs := []func(context.Context) error{f, f, f} | ||
| errs := []error{assert.AnError, assert.AnError, assert.AnError} | ||
| target := fmt.Errorf("%v", errs) | ||
| assert.Equal(t, unify(funcs)(context.Background()), target) | ||
| } | ||
|
|
||
| func TestWithResource(t *testing.T) { | ||
| res := resource.NewSchemaless() | ||
| c := newConfig([]Option{WithResource(res)}) | ||
| assert.Same(t, res, c.res) | ||
| } | ||
|
|
||
| func TestWithReader(t *testing.T) { | ||
| r := &reader{} | ||
| c := newConfig([]Option{WithReader(r)}) | ||
| assert.Contains(t, c.readers, r) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright The 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. | ||
|
|
||
| //go:build go1.17 | ||
| // +build go1.17 | ||
|
|
||
| package metric | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestForceFlushConcurrentSafe(t *testing.T) { | ||
| mp := NewMeterProvider() | ||
|
|
||
| go func() { | ||
| _ = mp.ForceFlush(context.Background()) | ||
| }() | ||
|
|
||
| _ = mp.ForceFlush(context.Background()) | ||
| } | ||
|
|
||
| func TestShutdownConcurrentSafe(t *testing.T) { | ||
| mp := NewMeterProvider() | ||
|
|
||
| go func() { | ||
| _ = mp.Shutdown(context.Background()) | ||
| }() | ||
|
|
||
| _ = mp.Shutdown(context.Background()) | ||
| } | ||
|
|
||
| func TestForceFlushDoesNotPanicForEmptyMeterProvider(t *testing.T) { | ||
| mp := MeterProvider{} | ||
| assert.NotPanics(t, func() { _ = mp.ForceFlush(context.Background()) }) | ||
| } | ||
|
|
||
| func TestShutdownDoesNotPanicForEmptyMeterProvider(t *testing.T) { | ||
| mp := MeterProvider{} | ||
| assert.NotPanics(t, func() { _ = mp.Shutdown(context.Background()) }) | ||
| } |