update automatically settting gomemlimit #1188
Conversation
|
Adding some documentation somewhere on this. |
docs/sources/reference/cli/run.md
Outdated
| @@ -164,6 +164,12 @@ original configuration. | |||
| Include `--config.extra-args` to pass additional command line flags from the original format to the converter. | |||
| Refer to [alloy convert][] for more details on how `extra-args` work. | |||
|
|
|||
| ## Automatic setting of GOMEMLIMIT | |||
There was a problem hiding this comment.
@clayton-cornell I have no idea where to put this doc. I could put it in the environment variable section we have going since it relates closely to that. Maybe around the kubernetes sections since that is where it will be used 90% of the time.
There was a problem hiding this comment.
I would lean towards adding it to the Env Var topic and linking to the env var topic from wherever in the Kubernetes topics.
This would also push things to get the first draft of the env var topic published (and we can expand it as needed vs trying to capture additional vars).
There was a problem hiding this comment.
Now that the Env Var topic is live, should the GOMEMLIMIT info be shifted over?
There was a problem hiding this comment.
I havent forgotten this, on my todo list after I get the patch release out.
docs/sources/reference/cli/run.md
Outdated
| @@ -164,6 +164,12 @@ original configuration. | |||
| Include `--config.extra-args` to pass additional command line flags from the original format to the converter. | |||
| Refer to [alloy convert][] for more details on how `extra-args` work. | |||
|
|
|||
| ## Automatic setting of GOMEMLIMIT | |||
|
|
|||
| The `GOMEMLIMIT` variable will be automatically set if {{< param "PRODUCT_NAME" >}} can determine the appropriate value. If the `GOMEMLIMIT` value is set before running {{< param "PRODUCT_NAME" >}} then that setting will be honored. The value will be set to 90% of the cgroup value set. | |||
There was a problem hiding this comment.
What is it set to when the appropriate value cannot be determined? if there is no cgroup? I imagine it's then not set, but just maybe good idea to doc that.
There was a problem hiding this comment.
That is correct, I can explicitly call that out.
| @@ -197,9 +197,7 @@ func (fr *alloyRun) Run(configPath string) error { | |||
|
|
|||
| // Set the memory limit, this will honor GOMEMLIMIT if set | |||
| // If there is a cgroup will follow that | |||
| if fr.minStability.Permits(featuregate.StabilityPublicPreview) { | |||
There was a problem hiding this comment.
Want to remove the Permits function? 😂
It could be useful though, just that I don't think it's used now so YAGNI.
| @@ -35,4 +36,12 @@ Argument | Description | D | |||
| ---------------------------|-------------------------------------------------|-------- | |||
| `http://proxy.example.com` | The hostname or IP address of the proxy server. | | |||
|
|
|||
| ### GOMEMLIMIT | |||
|
|
|||
| Normally the [Go runtime][runtime] will release memory back to the Operating System when requested. In certain environments this may cause issues such as Out of Memory errors. The `GOMEMLIMIT` variable is a numeric value in bytes with an optional unit suffix. The supported suffixes include B, KiB, MiB, GiB, and TiB. This should not be treated has a hard limit. The process can use more memory if that memory is required. A rough number is to set `GOMEMLIMIT` to 90% of the maximum amount of memory usage. For example if you wanted to keep memory usage below `10GiB` then use `GOMEMLIMIT=8GiB`. | |||
There was a problem hiding this comment.
@clayton-cornell I added some doc here but its rough, would love additional eyes.
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
|
This PR has not had any activity in the past 30 days, so the |
|
@mattdurham this PR is getting stale. Do we want to move this info into the Env Vars topic? Or something else? |
|
Oh jeez, we should. I will get this updated and ready tomorrow. |
|
Updated from main. Fixed a logical typo I had in the doc. |
|
@mattdurham Is this one ready to merge? |
PR Description
Graduate automatically setting gomemlimit to GA. It has been in public preview with no problems for two releases. Manually setting the value is something we tell users to do often so this mimics that if they have a limit set, ie most commonly through kubernetes.