Skip to content

Commit

Permalink
Adding upgrade section for memory_ballast (#4543)
Browse files Browse the repository at this point in the history
Co-authored-by: Dmitry Anoshin <anoshindx@gmail.com>
Co-authored-by: Antoine Toulme <antoine@toulme.name>
Co-authored-by: Aunsh Chaudhari <aunsh04@yahoo.in>
  • Loading branch information
4 people committed Mar 26, 2024
1 parent 38f46e7 commit d7e69cd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
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%
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
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

0 comments on commit d7e69cd

Please sign in to comment.