Skip to content

Commit

Permalink
cleaned up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gmmorris committed Jun 9, 2021
1 parent 0270133 commit 2b14158
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,15 @@ a| Runtime
a| Capacity Estimation

| experimental[] This section provides a rough estimate about the sufficiency of its capacity. As the name suggests, these are estimates based on historical data and should not be used as predictions. Use these estimations when following the Task Manager <<task-manager-scaling-guidance>>.
The `status` indicates the sufficiency of the observed capacity. An `OK` status means capacity is sufficient. A `Warning` status means that capacity is sufficient for the scheduled recurring tasks, but non-recurring tasks often cause the cluster to exceed capacity. An `Error` status means that there is insufficient capacity across all types of tasks.

|===

Each section has a `timestamp` and a `status` that indicates when the last update to this section took place and whether the health of this section was evaluated as `OK`, `Warning` or `Error`.

The root `status` indicates the `status` of the system overall.

The Runtime `status` indicates whether task executions have exceeded any of the <<task-manager-configuring-health-monitoring,configured health thresholds>>. An `OK` status means none of the threshold have been exceeded. A `Warning` status means that at least one warning threshold has been exceeded. An `Error` status means that at least one error threshold has been exceeded.

experimental[] The Capacity Estimation `status` indicates the sufficiency of the observed capacity. An `OK` status means capacity is sufficient. A `Warning` status means that capacity is sufficient for the scheduled recurring tasks, but non-recurring tasks often cause the cluster to exceed capacity. An `Error` status means that there is insufficient capacity across all types of tasks.

By monitoring the `status` of the system overall, and the `status` of specific task types of interest, you can evaluate the health of the {kib} Task Management system.
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,9 @@ A default {kib} instance can support up to `200/tpm`.
[float]
===== Automatic estimation

experimental[] As demonstrated in <<task-manager-health-evaluate-the-capacity-estimation, Evaluate your capacity estimation>>, the Task Manager <<task-manager-health-monitoring, health monitoring>> performs these estimations automatically.
experimental[]

As demonstrated in <<task-manager-health-evaluate-the-capacity-estimation, Evaluate your capacity estimation>>, the Task Manager <<task-manager-health-monitoring, health monitoring>> performs these estimations automatically.

These estimates are based on historical data and should not be used as predictions, but can be used as a rough guide when scaling the system.

Expand All @@ -135,7 +137,11 @@ We recommend provisioning at least as many {kib} instances as proposed by `propo

[WARNING]
============================================================================
Automatic capacity estimation is performed by each {kib} instance indipendently. This estimation is performed by observing the task throughput in that instance, the number of {kib} instances executing tasks at that moment in time, and the recurring workload in {es}. If a {kib} instance is idle at the moment of capacity estimation, the number of active {kib} might be miscounted, miscalculating the available throughput as a consequence. When evaluating the `proposed.proposed_kibana`, we highly recommend verifying that the `observed.observed_kibana_instances` matches the number of provisioned {kib} instances.
Automatic capacity estimation is performed by each {kib} instance indipendently. This estimation is performed by observing the task throughput in that instance, the number of {kib} instances executing tasks at that moment in time, and the recurring workload in {es}.
If a {kib} instance is idle at the moment of capacity estimation, the number of active {kib} might be miscounted, miscalculating the available throughput as a consequence.
When evaluating the `proposed.proposed_kibana`, we highly recommend verifying that the `observed.observed_kibana_instances` matches the number of provisioned {kib} instances.
============================================================================

[float]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,9 @@ For details on scaling Task Manager, see <<task-manager-scaling-guidance>>.
[[task-manager-health-evaluate-the-capacity-estimation]]
===== Evaluate the Capacity Estimation

experimental[] Task Manager is constantly evaluating its runtime operations and workload. This enables Task Manager to make rough estimates about the sufficiency of its capacity.
experimental[]

Task Manager is constantly evaluating its runtime operations and workload. This enables Task Manager to make rough estimates about the sufficiency of its capacity.

As the name suggests, these are estimates based on historical data and should not be used as predictions. These estimations should be evaluated alongside the detailed <<task-manager-health-monitoring>> stats before making changes to infrastructure. These estimations assume all {kib} instances are configured identically.

Expand Down

0 comments on commit 2b14158

Please sign in to comment.