Skip to content

Commit

Permalink
[chore] [processor/memory_limiter] docs: fix default value of `spike_…
Browse files Browse the repository at this point in the history
…limit_percentage` (#12065)

Verified with this config:

```yaml
processors:
  memory_limiter:
    check_interval: 1s
    limit_percentage: 50
```

Output:

```console
2025-01-10T10:55:58.072+0100    info    [email protected]/memorylimiter.go:151     Using percentage memory limiter {"kind": "processor", "name": "memory_limiter", "pipeline": "logs", "total_memory_mib": 31755, "limit_percentage": 50, "spike_limit_percentage": 0}
2025-01-10T10:55:58.072+0100    info    [email protected]/memorylimiter.go:75      Memory limiter configured       {"kind": "processor", "name": "memory_limiter", "pipeline": "logs", "limit_mib": 15877, "spike_limit_mib": 3175, "check_interval": 1}
```
  • Loading branch information
andrzej-stencel authored Jan 10, 2025
1 parent e7b52a2 commit cdea826
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion processor/memorylimiterprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This option is used to calculate `memory_limit` from the total available memory.
For instance setting of 75% with the total memory of 1GiB will result in the limit of 750 MiB.
The fixed memory setting (`limit_mib`) takes precedence
over the percentage configuration.
- `spike_limit_percentage` (default = 0): Maximum spike expected between the
- `spike_limit_percentage` (default = 20% of `limit_percentage`): Maximum spike expected between the
measurements of memory usage. The value must be less than `limit_percentage`.
This option is used to calculate `spike_limit_mib` from the total available memory.
For instance setting of 25% with the total memory of 1GiB will result in the spike limit of 250MiB.
Expand Down

0 comments on commit cdea826

Please sign in to comment.