Skip to content

Commit b663a24

Browse files
authored
Merge pull request #102537 from openshift-cherrypick-robot/cherry-pick-101867-to-standalone-coo-docs-1-latest
[standalone-coo-docs-1-latest] OBSDOCS-2695: [COO] Update signal correlation panel for COO 1.3 release.
2 parents 3ab241d + 4f9254d commit b663a24

12 files changed

+76
-120
lines changed

_attributes/common-attributes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
:cmo-full: Cluster Monitoring Operator
3939
:cmo-short: CMO
4040
41+
// Observability Signal Correlation
42+
:korrel8r: https://github.com/korrel8r/korrel8r[Korrel8r]
43+
:sync: image:fa-sync-alt.svg[Sync,20]
4144
4245
// Cluster Observability Operator
4346
:coo-first: Cluster Observability Operator (COO)
-31.1 KB
Binary file not shown.
210 KB
Loading
137 KB
Loading
85.4 KB
Loading
364 KB
Loading

images/fa-sync-alt.svg

Lines changed: 2 additions & 0 deletions
Loading
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
3+
// * observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="coo-troubleshooting-ui-plugin-advanced_{context}"]
7+
= Advanced controls for the {coo-full} troubleshooting panel UI plugin
8+
9+
The **Advanced** button opens additional controls over the correlation search.
10+
These are *experimental* and might change in a future release.
11+
They provide access to additional features of the {korrel8r} upstream project that powers the correlation search.
12+
13+
image::coo-troubleshooting-panel-advanced.png[Advanced Controls]
14+
15+
16+
The following list explains the additional controls under the *Advanced* button:
17+
18+
* **Recent** The search is limited to recent results, by default in the last day.
19+
* **Range** Allows searching an explicit date/time range in the past.
20+
* **Distance** Searches up to the given distance from the starting point.
21+
Each correlation rule (edge in the graph) is a "step", and the **distance** is the maximum number of steps.
22+
* **Goal Class** Instead of a distance, you can select a **goal**, which is a resource or signal type.
23+
This searches for paths from the start to the goal type, and the path length is not limited.
24+
For more information about correlation classes, see the {korrel8r} project documentation.
25+
* **Query** The {korrel8r} query representing the starting point for the search.
26+
Click **Focus** to reset the query to reflect the current console page.
27+
Click **Sync** to re-run the current query and update the graph.
28+
For more information about correlation queries, see the {korrel8r} project documentation.
29+

modules/coo-troubleshooting-ui-plugin-creating-alert.adoc

Lines changed: 0 additions & 46 deletions
This file was deleted.

modules/coo-troubleshooting-ui-plugin-install.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@ metadata:
2424
name: troubleshooting-panel
2525
spec:
2626
type: TroubleshootingPanel
27-
----
27+
----
28+

0 commit comments

Comments
 (0)