luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

backport of commit 1e9ccc3ed89adcdfaf4282d432782c03e0e5c615 (#18261) 

Co-authored-by: János Szathmáry <29057504+janory@users.noreply.github.com>
This commit is contained in:
hc-github-team-nomad-core 2023-08-18 16:44:54 -05:00 committed by GitHub
parent 1397ec4ad6
commit 27a14e4da1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/content/tools/autoscaling/plugins/apm/nomad.mdx
View File

@ -8,8 +8,14 @@ description: The "nomad-apm" APM plugin queries the Nomad API for metrics.
The Nomad APM plugin allows querying the Nomad API for metric data. This provides
an immediate starting point without addition applications but comes at the price
of efficiency. When using this APM, it is advised to monitor Nomad carefully
ensuring it is not put under excessive load pressure.
of efficiency and flexibility. When using this APM, it is advised to monitor
Nomad carefully ensuring it is not put under excessive load pressure.
Since Nomad does not store historical metric data and only reports instant
metrics values, the Nomad APM plugin does not support the [`query_window`][]
policy option and is not able to aggregate metrics over time, such as computing
averages or percentiles. An external APM is required to support uses cases like
these.
~> The Nomad APM plugin should only be used when scaling based on CPU and
memory usage. For more advanced scenarios, such as scaling a cluster to
@ -129,3 +135,4 @@ The metric value can be:
the total allocated by the scheduler.
[nomad_telemetry_block]: /nomad/docs/configuration/telemetry#inlinecode-publish_allocation_metrics
[`query_window`]: /nomad/tools/autoscaling/policy#query_window

4
website/content/tools/autoscaling/policy.mdx
View File

@ -65,7 +65,9 @@ horizontal application scaling or horizontal cluster scaling.
can be found on the [APM Plugins][apm_plugin_docs] page.
- `query_window` - Defines how far back to query the APM for metrics. It should
be provided as a duration (e.g.: `"5s"`, `"1m"`). Defaults to `1m`.
be provided as a duration (e.g.: `"5s"`, `"1m"`). Defaults to `1m`. This
value may not be supported by all APM plugins. Refer to the documentation of
the specific APM plugin being used for more information.
- `group` - Specifies which checks should treated as correlated when the policy
is evaluated. Refer to [Check Grouping][concepts_grouping] for more