Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding upgrade section for memory_ballast #4543

Merged
merged 4 commits into from Mar 26, 2024
Merged

Adding upgrade section for memory_ballast #4543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4151375
adding upgrade section for memory_ballast
samiura Mar 26, 2024
0406264
Update the guideline
dmitryax Mar 26, 2024
151f958
Update README.md
samiura Mar 26, 2024
fe072e0
Update README.md
dmitryax Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -176,6 +176,18 @@ manually before the backward compatibility is dropped. For every configuration u
[the default agent config](https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/agent_config.yaml)
as a reference.

### From 0.96.1 to 0.97.0

- `memory_ballast` is no longer effective. The garbage collection is now controlled by the soft memory limit set to 90%
dmitryax marked this conversation as resolved.
Show resolved Hide resolved
of total memory (`SPLUNK_MEMORY_TOTAL_MIB` env var) by default.

If you haven't customized the `memory_ballast`, just remove it from the configuration.

If you have customized it via `SPLUNK_BALLAST_SIZE_MIB` (or `extensions::memory_ballast::size_mib` config), you should
remove the `memory_ballast` extension and use the [`GOMEMLIMIT`](https://pkg.go.dev/runtime) environment variable to set a custom soft memory limit:
- To increase frequency of garbage collections: set `GOMEMLIMIT` to a higher value than the default 90% of total memory.
- To decrease frequency of garbage collections: set `GOMEMLIMIT` to a lower value than the default 90% of total memory.

### From 0.68.0 to 0.69.0

- `gke` and `gce` resource detectors in `resourcedetection` processor are replaced with `gcp` resource detector.
Expand Down
3 changes: 2 additions & 1 deletion internal/configconverter/remove_memory_ballast_key.go
View file
Open in desktop
Expand Up @@ -51,7 +51,8 @@ func (RemoveMemoryBallastKey) Convert(_ context.Context, cfgMap *confmap.Conf) e
out := map[string]any{}
for _, k := range cfgMap.AllKeys() {
if firstRegExp.MatchString(k) {
log.Println("[WARNING] `memory_ballast` parameter in extensions is deprecated. Please remove it from your configuration.")
log.Println("[WARNING] `memory_ballast` extension is deprecated. Please remove it from your configuration. " +
"See https://github.com/signalfx/splunk-otel-collector#from-0961-to-0970 for more details")
continue
}
if secondRegExp.MatchString(k) {
Expand Down