Skip to content

Commit bfe9f28

Browse files
STAC-23444: add page on ui extension troubleshooting (#109)
* STAC-23444: add page on ui extension troubleshooting Co-authored-by: akashraj4261 <[email protected]>
1 parent c327902 commit bfe9f28

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

docs/latest/modules/en/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@
111111
*** xref:setup/install-stackstate/troubleshooting.adoc[Troubleshooting]
112112
**** xref:setup/install-stackstate/advanced-troubleshooting.adoc[Advanced Troubleshooting]
113113
**** xref:setup/install-stackstate/support-package-logs.adoc[Support Package (Logs)]
114+
**** xref:setup/install-stackstate/extension-troubleshooting.adoc[UI Extension Troubleshooting]
114115
** Configure SUSE Observability
115116
*** xref:setup/configure-stackstate/slack-notifications.adoc[Slack notifications]
116117
*** xref:setup/configure-stackstate/email-notifications.adoc[E-mail notifications]

docs/latest/modules/en/pages/k8s-suse-rancher-prime.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,8 @@ sts service-token create --name suse-observability-extension --roles stackstate-
371371

372372
| 2.x.x
373373
| 2.10 +
374-
2.11
374+
2.11 +
375+
2.12
375376
|===
376377

377378
== Installing the SUSE Observability Agent
@@ -436,3 +437,7 @@ To enable Single sign-on with your own authentication provider please xref:/setu
436437
. After the extensions are installed, the SUSE Observability UI opens in the same tab as the Rancher UI.
437438
** You can use shift-click to open in a new tab, this will become the default behaviour
438439
. Be aware upgrading or downgrading from HA to NON-HA and vice-versa is not yet supported.
440+
441+
== Troubleshooting
442+
443+
For any queries regarding the installation of the UI extension for Observability, see xref:/setup/install-stackstate/extension-troubleshooting.adoc[Extension troubleshooting guide].
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
= Extension Troubleshooting
2+
:revdate: 2025-11-03
3+
:page-revdate: {revdate}
4+
:description: SUSE Observability Self-hosted
5+
6+
This section provides troubleshooting steps for any interoperability issues between {stackstate-product-name} and the Rancher UI extension.
7+
8+
== Collect a HAR (Http ARchive)
9+
10+
Http ARchive collects details on requests that are sent by the browser to Rancher and {stackstate-product-name}. It also logs the responses received.
11+
This archive is specific to the page/browser tab with the error. It does not need access to the backing Rancher or {stackstate-product-name} instances (though their logs may be useful at a later stage).
12+
13+
* Open the *Network* tab in the "Developer Tools" panel. You can access this by using `F12`. The network tab shows a log of all requests that are made.
14+
* Clear the log and do a (hard) refresh of the page that is displaying the problematic behavior.
15+
* There should now be a large number of requests to both Rancher and SUSE Observability visible.
16+
* Export/Download/Save the HAR - different browsers use different names here.
17+
18+
== Cluster is unobserved
19+
20+
For the cluster health status to be visible in Rancher, there needs to be alignment between these configurations:
21+
22+
* The (display) name of the cluster in the Rancher UI.
23+
* The `stackstate.cluster.name` set on the agent deployed on the cluster
24+
* The cluster name in the configuration of the Kubernetes stackpack in SUSE Observability
25+
26+
A mismatch will tend to show up as "no data received" in the cluster overview in Rancher.
27+
28+
== Connection failed
29+
30+
The configuration for SUSE Observability may sometimes not yield a valid connection in the Rancher UI due to the following reasons:
31+
32+
* The Rancher host is not configured as an allowed origin for SUSE Observability. You can fix this by adding it to the `stackstate.allowedOrigins` list in the helm values, or by passing `--set stackstate.allowedOrigins={"https://<rancher-url>"}` to the deployment command.
33+
* SUSE Observability is not accessible from the browser. For example, the root certificate has not been installed.

0 commit comments

Comments
 (0)