From a27ea60e3014874f666ec6d3b408c67fa445a40d Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Wed, 29 Apr 2026 18:51:16 -0700 Subject: [PATCH 1/8] docs: add visibility into integrations health Add documentation for the new Connections dashboard that provides visibility into integration health, including status indicators, linked models, metric sources, and troubleshooting guidance. [sc-15885] --- .../integrations/configure-connections.qmd | 55 ++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index dfa716269e..d3a236de0e 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -163,7 +163,7 @@ Required configuration details: You can now [test the connection](#test-connections) to ensure it is working as expected. -## View details +## View connection details 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -171,6 +171,57 @@ You can now [test the connection](#test-connections) to ensure it is working as 3. Click the connection you want to view. +The connection details page shows: + +- **Status** — The current operational state of the connection. +- **Linked models** — Models in your inventory that use this connection. +- **Metric sources** — External metrics being synced from this integration. +- **Recent activity** — Sync history and any errors. + +## Monitor connection health + +The Connections dashboard provides visibility into the health of your integrations at a glance. + +### Health indicators + +Each connection displays a status indicator: + +- [Operational]{.bubble} — The connection is active and working correctly. +- [Degraded]{.bubble} — The connection is experiencing issues but is still partially functional. +- [Error]{.bubble} — The connection has failed and needs attention. +- [Disabled]{.bubble} — The connection has been manually disabled. + +### View connections requiring attention + +Connections with errors or warnings appear at the top of the list. Review these connections to: + +1. Identify the cause of the issue from the error details. +2. Check that required secrets are still valid. +3. Verify the external service is accessible. +4. Test the connection after making changes. + +### View linked models + +To see which models use a specific connection: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click the connection to open its details page. + +4. Review the Linked Models section to see all models associated with this integration. + +### View metric sources + +For connections that provide monitoring metrics, such as Amazon Bedrock: + +1. Open the connection details page. + +2. Review the Metric Sources section to see available metrics. + +3. These metrics can be added to monitoring documents for models linked to this connection.[^5] + ## Edit connections 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -225,3 +276,5 @@ If the test is successful, the message **{{< fa check-circle >}} Connection succ [^4]: [Implement custom integrations](implement-custom-integrations.qmd) +[^5]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd) + From 0f81df219b4c6c365a4f917292e6583cb03b42c2 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Wed, 29 Apr 2026 23:43:45 -0700 Subject: [PATCH 2/8] Fix: connections with issues show status indicator, not sorted to top --- site/guide/integrations/configure-connections.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index d3a236de0e..cc769bdff7 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -193,7 +193,7 @@ Each connection displays a status indicator: ### View connections requiring attention -Connections with errors or warnings appear at the top of the list. Review these connections to: +Connections with errors or warnings display a status indicator. Review these connections to: 1. Identify the cause of the issue from the error details. 2. Check that required secrets are still valid. From 24037e4cd221bc34099fb229014f698e41b49f6d Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Wed, 29 Apr 2026 23:53:12 -0700 Subject: [PATCH 3/8] Add example status indicator for sync errors --- site/guide/integrations/configure-connections.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index cc769bdff7..dfa13eb6c6 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -193,7 +193,7 @@ Each connection displays a status indicator: ### View connections requiring attention -Connections with errors or warnings display a status indicator. Review these connections to: +Connections with errors or warnings display a status indicator, such as [{{< fa triangle-exclamation >}} 1 link with sync errors]{.bubble .yellow-bg}. Review these connections to: 1. Identify the cause of the issue from the error details. 2. Check that required secrets are still valid. From f140d6b4b36645b510d6ab83ea486f7c7de9e021 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Wed, 29 Apr 2026 23:58:37 -0700 Subject: [PATCH 4/8] Fix connection status labels and colors to match frontend --- site/guide/integrations/configure-connections.qmd | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index dfa13eb6c6..2d585547f1 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -186,9 +186,8 @@ The Connections dashboard provides visibility into the health of your integratio Each connection displays a status indicator: -- [Operational]{.bubble} — The connection is active and working correctly. -- [Degraded]{.bubble} — The connection is experiencing issues but is still partially functional. -- [Error]{.bubble} — The connection has failed and needs attention. +- [Operational]{.bubble .green-bg} — The connection is active and working correctly. +- [Needs Attention]{.bubble .orange-bg} — The connection has issues that need to be resolved. - [Disabled]{.bubble} — The connection has been manually disabled. ### View connections requiring attention From f77598626d50324fa77d262e34c9a885036bf131 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Thu, 30 Apr 2026 00:03:19 -0700 Subject: [PATCH 5/8] Clarify Linked Models shows both VM records and external models --- site/guide/integrations/configure-connections.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 2d585547f1..66fdec0430 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -209,7 +209,7 @@ To see which models use a specific connection: 3. Click the connection to open its details page. -4. Review the Linked Models section to see all models associated with this integration. +4. Review the **Linked Models** section to see the ValidMind inventory records and the external models they are linked to. ### View metric sources From 23bb9c09f15c415b9b2c115f784b4e2be596ad29 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Thu, 30 Apr 2026 00:05:52 -0700 Subject: [PATCH 6/8] Fix: describe linked models table with correct column names --- site/guide/integrations/configure-connections.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 66fdec0430..f8ce3a43ac 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -209,7 +209,7 @@ To see which models use a specific connection: 3. Click the connection to open its details page. -4. Review the **Linked Models** section to see the ValidMind inventory records and the external models they are linked to. +4. Review the linked models table, which shows the **VM Model** (ValidMind inventory record) and **External Name** (the linked external model) for each connection. ### View metric sources From 26c9cd4ac87b48718296a5aae27b328187541586 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Thu, 30 Apr 2026 00:06:58 -0700 Subject: [PATCH 7/8] Use vm.product variable instead of hardcoded ValidMind --- site/guide/integrations/configure-connections.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index f8ce3a43ac..918efa4c1c 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -209,7 +209,7 @@ To see which models use a specific connection: 3. Click the connection to open its details page. -4. Review the linked models table, which shows the **VM Model** (ValidMind inventory record) and **External Name** (the linked external model) for each connection. +4. Review the linked models table, which shows the **VM Model** ({{< var vm.product >}} inventory record) and **External Name** (the linked external model) for each connection. ### View metric sources From 3c0a0bfc08019eaff6d71b0ca295f2488182e0ae Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Thu, 30 Apr 2026 15:10:04 -0700 Subject: [PATCH 8/8] docs: Remove inaccurate Recent activity bullet The connection details page has Links and Monitoring tabs, not a recent activity/sync history section. Sync errors appear as badges on the row, not in a feed. --- site/guide/integrations/configure-connections.qmd | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 918efa4c1c..49dddd5e1d 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -16,7 +16,7 @@ Each connection enables you to authenticate and keep events flowing between plat - [x] {{< var link.login >}} - [x] You can manage workspace settings.[^1] -- [x] The integration’s required secrets already exist in integration secrets.[^2] +- [x] The integration's required secrets already exist in integration secrets.[^2] - [x] You coordinated with the external system owner to obtain the required credentials and configuration details for the connection. ::: @@ -176,7 +176,6 @@ The connection details page shows: - **Status** — The current operational state of the connection. - **Linked models** — Models in your inventory that use this connection. - **Metric sources** — External metrics being synced from this integration. -- **Recent activity** — Sync history and any errors. ## Monitor connection health @@ -276,4 +275,3 @@ If the test is successful, the message **{{< fa check-circle >}} Connection succ [^4]: [Implement custom integrations](implement-custom-integrations.qmd) [^5]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd) -