Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/memorylimiter_middleware.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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. otlpreceiver)
component: extension/memory_limiter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: The memorylimiter extension can be used as an HTTP/GRPC middleware.

# One or more tracking issues or pull requests related to the change
issues: [14081]

# (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:

# 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]
2 changes: 1 addition & 1 deletion cmd/otelcorecol/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ require (
go.opentelemetry.io/collector/exporter/xexporter v0.139.0 // indirect
go.opentelemetry.io/collector/extension/extensionauth v1.45.0 // indirect
go.opentelemetry.io/collector/extension/extensioncapabilities v0.139.0 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v0.139.0 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v1.45.0 // indirect
go.opentelemetry.io/collector/extension/extensiontest v0.139.0 // indirect
go.opentelemetry.io/collector/extension/xextension v0.139.0 // indirect
go.opentelemetry.io/collector/featuregate v1.45.0 // indirect
Expand Down
25 changes: 24 additions & 1 deletion extension/memorylimiterextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,29 @@ The memory limiter extension is used to prevent out of memory situations on
the collector. The extension will potentially replace the Memory Limiter Processor.
It provides better guarantees from running out of memory as it will be used by the
receivers to reject requests before converting them into OTLP. All the configurations
are the same as Memory Limiter Processor. The extension is under development and does nothing.
are the same as Memory Limiter Processor.


This extension can be used as an extension for all HTTP and gRPC receivers that
are configured through the standard `confighttp` and `configgrpc` libraries. For
example, to configure this extension in the OTLP receiver:

```
receivers:
otlp:
protocols:
grpc:
middlewares:
- id: memory_limiter
http:
middlewares:
- id: memory_limiter

extensions:
memory_limiter:
check_interval: 1s
limit_percentage: 1
spike_limit_percentage: 0.05
```

see [memorylimiterprocessor](../../processor/memorylimiterprocessor/README.md) for additional details
8 changes: 8 additions & 0 deletions extension/memorylimiterextension/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ require (
go.opentelemetry.io/collector/component/componenttest v0.139.0
go.opentelemetry.io/collector/confmap v1.45.0
go.opentelemetry.io/collector/extension v1.45.0
go.opentelemetry.io/collector/extension/extensionmiddleware v1.45.0
go.opentelemetry.io/collector/extension/extensiontest v0.139.0
go.opentelemetry.io/collector/internal/memorylimiter v0.139.0
go.uber.org/goleak v1.3.0
go.uber.org/zap v1.27.0
google.golang.org/grpc v1.76.0
)

require (
Expand Down Expand Up @@ -49,7 +51,11 @@ require (
go.opentelemetry.io/otel/trace v1.38.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/net v0.42.0 // indirect
golang.org/x/sys v0.37.0 // indirect
golang.org/x/text v0.27.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250804133106-a7a43d27e69b // indirect
google.golang.org/protobuf v1.36.10 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)

Expand All @@ -70,3 +76,5 @@ replace go.opentelemetry.io/collector/extension/extensiontest => ../../extension
replace go.opentelemetry.io/collector/featuregate => ../../featuregate

replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil

replace go.opentelemetry.io/collector/extension/extensionmiddleware => ../../extension/extensionmiddleware
12 changes: 12 additions & 0 deletions extension/memorylimiterextension/go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions extension/memorylimiterextension/memorylimiter.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ package memorylimiterextension // import "go.opentelemetry.io/collector/extensio

import (
"context"
"net/http"

"go.uber.org/zap"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"

"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/internal/memorylimiter"
Expand Down Expand Up @@ -38,3 +42,24 @@ func (ml *memoryLimiterExtension) Shutdown(ctx context.Context) error {
func (ml *memoryLimiterExtension) MustRefuse() bool {
return ml.memLimiter.MustRefuse()
}

func (ml *memoryLimiterExtension) GetHTTPHandler(base http.Handler) (http.Handler, error) {
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
if ml.MustRefuse() {
http.Error(resp, http.StatusText(http.StatusTooManyRequests), http.StatusTooManyRequests)
return
}
base.ServeHTTP(resp, req)
}), nil
}

func (ml *memoryLimiterExtension) GetGRPCServerOptions() ([]grpc.ServerOption, error) {
return []grpc.ServerOption{grpc.UnaryInterceptor(
func(ctx context.Context, req any, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp any, err error) {
if ml.MustRefuse() {
return nil, status.Errorf(codes.ResourceExhausted, "RESOURCE_EXHAUSTED")
}
return handler(ctx, req)
},
)}, nil
}
6 changes: 6 additions & 0 deletions extension/memorylimiterextension/memorylimiter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"go.uber.org/zap"

"go.opentelemetry.io/collector/component/componenttest"
"go.opentelemetry.io/collector/extension/extensionmiddleware"
"go.opentelemetry.io/collector/internal/memorylimiter"
"go.opentelemetry.io/collector/internal/memorylimiter/iruntime"
)
Expand Down Expand Up @@ -95,3 +96,8 @@ func TestMemoryPressureResponse(t *testing.T) {
})
}
}

func TestMiddleware(t *testing.T) {
Copy link
Contributor

@evan-bradley evan-bradley Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of having a test for this, could we use the type checker to assert interface implementation?

You could put the following above line 19 in memorylimiter.go for example:

var _ extensionmiddleware.GRPCServer = (*memoryLimiterExtension)(nil)
var _ extensionmiddleware.HTTPServer = (*memoryLimiterExtension)(nil)

assert.Implements(t, (*extensionmiddleware.HTTPServer)(nil), &memoryLimiterExtension{}, "memoryLimiterExtension does not impplement extensionmiddleware.HTTPServer interface")
assert.Implements(t, (*extensionmiddleware.GRPCServer)(nil), &memoryLimiterExtension{}, "memoryLimiterExtension does not impplement extensionmiddleware.GRPCServer interface")
}