forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[processor/deltatocumulative] limit tracked streams (open-telemetry#3…
…1488) **Description:** Adds a configurable upper limit to the number of tracked streams. This allows to introduce a upper bound to the memory usage. **Testing:** Test case was added **Documentation:** README was updated
- Loading branch information
1 parent
253ba18
commit bbd8c5d
Showing
10 changed files
with
189 additions
and
8 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: "enhancement" | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
component: "deltatocumulativeprocessor" | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: introduce configurable stream limit | ||
|
||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
issues: [31488] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: | | ||
Adds `max_streams` option that allows to set upper bound (default = unlimited) | ||
to the number of tracked streams. Any additional streams exceeding the limit | ||
are dropped. | ||
# If your change doesn't affect end users or the exported elements of any package, | ||
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. | ||
# Optional: The change log or logs in which this entry should be included. | ||
# e.g. '[user]' or '[user, api]' | ||
# Include 'user' if the change is relevant to end users. | ||
# Include 'api' if there is a change to a library API. | ||
# Default: '[user]' | ||
change_logs: [user] |
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
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
63 changes: 63 additions & 0 deletions
63
processor/deltatocumulativeprocessor/internal/streams/limit.go
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,63 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package streams // import "github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/streams" | ||
|
||
import ( | ||
"errors" | ||
"fmt" | ||
|
||
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics/identity" | ||
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics/streams" | ||
) | ||
|
||
func Limit[T any](m Map[T], max int) LimitMap[T] { | ||
return LimitMap[T]{Map: m, Max: max} | ||
} | ||
|
||
type LimitMap[T any] struct { | ||
Max int | ||
|
||
Evictor streams.Evictor | ||
streams.Map[T] | ||
} | ||
|
||
func (m LimitMap[T]) Store(id identity.Stream, v T) error { | ||
if m.Map.Len() < m.Max { | ||
return m.Map.Store(id, v) | ||
} | ||
|
||
errl := ErrLimit(m.Max) | ||
if m.Evictor != nil { | ||
gone := m.Evictor.Evict() | ||
if err := m.Map.Store(id, v); err != nil { | ||
return err | ||
} | ||
return ErrEvicted{ErrLimit: errl, id: gone} | ||
} | ||
return errl | ||
} | ||
|
||
type ErrLimit int | ||
|
||
func (e ErrLimit) Error() string { | ||
return fmt.Sprintf("stream limit of %d reached", e) | ||
} | ||
|
||
func AtLimit(err error) bool { | ||
var errLimit ErrLimit | ||
return errors.As(err, &errLimit) | ||
} | ||
|
||
type ErrEvicted struct { | ||
ErrLimit | ||
id Ident | ||
} | ||
|
||
func (e ErrEvicted) Error() string { | ||
return fmt.Sprintf("%s. evicted stream %s", e.ErrLimit, e.id) | ||
} | ||
|
||
func (e ErrEvicted) Unwrap() error { | ||
return e.ErrLimit | ||
} |
51 changes: 51 additions & 0 deletions
51
processor/deltatocumulativeprocessor/internal/streams/limit_test.go
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,51 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package streams_test | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
|
||
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics/identity" | ||
exp "github.com/open-telemetry/opentelemetry-collector-contrib/internal/exp/metrics/streams" | ||
"github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/data" | ||
"github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/streams" | ||
"github.com/open-telemetry/opentelemetry-collector-contrib/processor/deltatocumulativeprocessor/internal/testdata/random" | ||
) | ||
|
||
func TestLimit(t *testing.T) { | ||
sum := random.Sum() | ||
|
||
items := make(exp.HashMap[data.Number]) | ||
lim := streams.Limit(items, 10) | ||
|
||
ids := make([]identity.Stream, 10) | ||
|
||
// write until limit must work | ||
for i := 0; i < 10; i++ { | ||
id, dp := sum.Stream() | ||
ids[i] = id | ||
err := lim.Store(id, dp) | ||
require.NoError(t, err) | ||
} | ||
|
||
// one over limit must be rejected | ||
{ | ||
id, dp := sum.Stream() | ||
err := lim.Store(id, dp) | ||
want := streams.ErrLimit(10) | ||
require.ErrorAs(t, err, &want) | ||
require.True(t, streams.AtLimit(err)) | ||
} | ||
|
||
// after removing one, must be accepted again | ||
{ | ||
lim.Delete(ids[0]) | ||
|
||
id, dp := sum.Stream() | ||
err := lim.Store(id, dp) | ||
require.NoError(t, err) | ||
} | ||
} |
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