You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: private-preview/aopt/aopt-derived-metrics.rst
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ Application Optimization's workload analysis produces the following metics. All
13
13
14
14
All metric names are constructed as ``<prefix>.<section>.<metric>``, where ``<prefix>`` is a prefix (likely either ``sf`` or ``o11y``), and ``<section>`` and ``<metric>`` correspond to columns in the table below.
15
15
16
-
Note: memory is specified in GiB.
16
+
.. note::
17
+
Memory is specified in GiB.
17
18
18
19
19
20
@@ -30,7 +31,7 @@ Note: memory is specified in GiB.
30
31
- **Notes**
31
32
-
32
33
33
-
- report
34
+
- ``report``
34
35
-
35
36
-
36
37
-
@@ -55,7 +56,7 @@ Note: memory is specified in GiB.
55
56
- ``coverage_ratio``
56
57
- W
57
58
- Window coverage with metrics: the ratio of number of actual metrics values found compared to the number of timeslots in the window. This should represent the worst case value (in other words, the minimum of the coverage of each input timeseries we use).
58
-
- This is used to determine the validity & confidence level of the report.
59
+
- This is used to determine the validity and confidence level of the report.
59
60
-
60
61
61
62
-
@@ -423,7 +424,7 @@ The following additional dimensions are applied to per-container metrics (any me
423
424
424
425
- ``k8s.container.pseudo_qos``
425
426
- Container-level pseudo-QoS
426
-
- to be considered, probably doesn't exist in the input metrics
427
+
-
427
428
428
429
Note: this set of additional attributes matches the set of additional attributes that per-container ``k8s`` metrics (such as memory and CPU utilization), provide on top of workload-level metrics (such as replica count). This excludes metadata attributes that are per pod instance (such ``as k8s.replica.set`` and ``k8s.pod.id``, since we always aggregate
429
430
metrics across instances), as well as per container instance (such as ``k8s.container.id``) for the same reason.
* Minimum amount of infrastructure metrics you must send to Splunk IM: 14 contiguous days. Minimum amount of infrastructure metrics you must send to Splunk IM: 14 contiguous days. This isn't strictly a requirement because instant recommendationss are still generated for less data, but with lower confidence scores
32
+
* Minimum amount of infrastructure metrics you must send to Splunk IM: 14 contiguous days. This isn't strictly a requirement because instant recommendationss are still generated for less data, but with lower confidence scores
33
33
34
34
* All metrics that the :new-page:`Splunk IM Kubernetes cluster receiver collects by default <https://docs.splunk.com/observability/en/gdi/opentelemetry/collector-kubernetes/install-k8s.html#helm-chart-supported-distros>` must be present in your data. Since these metrics are enabled by default on your Kubernetes collector you don't need to take any action unless you've disabled them.
Copy file name to clipboardExpand all lines: private-preview/aopt/aopt-scenarios.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,10 +39,10 @@ To see actual usage metrics for an individual workload:
39
39
40
40
#. Navigate to the :guilabel:`Application Optimization` dashboard.
41
41
42
-
#. Find the target workload in the :guilabel:`Kubernetes Workloads` table. :ref:`Sort, search, or filter this table <aopt-workloads>` as needed.
42
+
#. Find the target workload in the :guilabel:`Kubernetes Workloads` table. :ref:`Sort, search, or filter this table <aopt-workloads-sort-search>` as needed.
43
43
44
-
#. Select the target workload in the table to navigate to the :guilabel:`Workloads Details` page. This page displays actual usage metrics for the target workload.
44
+
#. Select the target workload in the table to navigate to the :guilabel:`Workloads Details` page. This page displays actual usage metrics for the target workload, divided into sections for each container in the workload.
45
45
46
-
#. In the :guilabel:`Instant Recommendations` section, copy the YAML snippets in the far right column and apply them to the corresponding containers in your workload.
46
+
#. In the :guilabel:`Instant Recommendations` section, expand each container's section and apply the YAML snippets in the rightmost column to that container's configuration.
Copy file name to clipboardExpand all lines: private-preview/aopt/aopt-workload-details.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,15 @@ Efficiency Analysis
22
22
23
23
:guilabel:`Efficiency Analysis` is based on the workload's resource efficiency.
24
24
25
-
* :guilabel:`Confidence level`: Look for the confidence level under the Efficiency Analysis label. If the confidence level is something other than high, this probably means that your cluster hasn't sent enough metrics to Splunk IM since you created the workload. In this case, for highly critical business workflows or those that have high variations, wait a few days for the confidence level to increase before you apply the recommendations. :ref:`See details on how this is calculated <aopt-glossary>`.
25
+
* :guilabel:`Confidence level`: Look for the confidence level under the :guilabel:`Efficiency Analysis` label. If the confidence level is something other than high, this probably means that your cluster hasn't sent enough metrics to Splunk IM since you created the workload. In this case, for highly critical business workflows or those that have high variations, wait a few days for the confidence level to increase before you apply the recommendations. :ref:`See details on how this is calculated <aopt-glossary-confidence-level>`.
26
26
27
27
* :guilabel:`Resource Starvation Risk`: This workload's average risk of running out of CPU or memory.
28
28
29
29
* :guilabel:`Average Pod Count`: The number of pods (:new-page:`replicas <https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/>`) running for this workload averaged over the analysis period.
30
30
31
31
* :guilabel:`Resource Footprint`: The percentage of CPU and memory that this workload's pods requested, averaged over the analysis period. The footprint may exceed 100% when the pods use more than their requested values.
32
32
33
-
* :guilabel:`Resource Efficiency`: The ratio of resource usage to resource allocation. This is a percentage relative to allocated resources. The higher the percentage, the better. :ref:`See details on how this is calculated <aopt-glossary>`.
33
+
* :guilabel:`Resource Efficiency`: The ratio of resource usage to resource allocation. This is a percentage relative to allocated resources. The higher the percentage, the better. :ref:`See details on how this is calculated <aopt-glossary-efficiency>`.
34
34
35
35
36
36
Instant Recommendations
@@ -48,7 +48,7 @@ If a workload has had a medium or high starvation risk over the past 14 days, ig
Your workload is broken down into its containers, and within the section for each container, there are specific recommendations for CPU and memory adjustments, a chart visualizing its historical resource usage, and on the far right, YAML snippets you can copy to improve its settings.
51
+
Your workload is broken down into its containers, and within the section for each container, there are specific recommendations for CPU and memory adjustments, a chart visualizing its historical resource usage, and in the rightmost column (:guilabel:`Recommended K8s Spec`), YAML snippets you can copy to improve its settings.
This is a good tile to check first to see if any of your workloads are at high risk of starvation. Those are the workloads that need immediate attention. You can also find starving workloads by sorting the :guilabel:`Kubernetes Workloads` table by :guilabel:`Starvation Risk`. :ref:`See details on how this risk is calculated <aopt-glossary>`.
40
+
This is a good tile to check first to see if any of your workloads are at high risk of starvation. Those are the workloads that need immediate attention. You can also find starving workloads by sorting the :guilabel:`Kubernetes Workloads` table by :guilabel:`Starvation Risk`. :ref:`See details on how this risk is calculated <aaopt-glossary-starvation-risk>`.
41
41
42
42
43
43
Resource Footprint
@@ -49,6 +49,8 @@ A workload's resource footprint is the sum of its pods' ``request`` settings for
49
49
This tile aggregates data from all of your workloads, so you may not find a direct correlation to individual workloads in the :guilabel:`Kubernetes Workloads` table.
0 commit comments