COO-169: feat: add troubleshooting panel and distributed tracing ui-plugin #480

PeterYurkovich · 2024-05-09T21:18:54Z

This PR adds the troubleshooting panel console plugin and distributed tracing console plugin to the observability operator.

openshift-ci-robot · 2024-05-09T21:18:57Z

@PeterYurkovich: This pull request references OU-378 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target either version "4.16." or "openshift-4.16.", but it targets "OpenShift 4.16" instead.

In response to this:

This PR addresses OU-378 and looks to add the Troubleshooting Panel console plugin to COO.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci · 2024-05-09T21:19:07Z

Hi @PeterYurkovich. Thanks for your PR.

I'm waiting for a rhobs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

jgbernalp · 2024-05-13T08:56:07Z

pkg/controllers/uiplugin/controller.go

@@ -251,7 +251,8 @@ func (rm resourceManager) registerPluginWithConsole(ctx context.Context, pluginI
 			OperatorSpec: operatorv1.OperatorSpec{
 				ManagementState: operatorv1.Managed,
 			},
-			Plugins: clusterPlugins,
+			Plugins:       clusterPlugins,
+			Customization: *cluster.Spec.Customization.DeepCopy(),


I wonder if this is really needed, this is a last resource path we are using and we should not change other things unrelated to plugins

I had found that the spec.customization.customLogoFile.key was being unset when the Patch method was called in reconciler.go for the Merger.Reconcile. This leads the Console Operator to get stuck in a reconciliation loop. This issue will pop up on all consoles using a custom image like ROSA. All this line does is ensure that the customization is available on both sides of the patch.

However, although this only happened with the customization it's possible it could happen with other items. I'm not exactly certain how to go about debugging this, but I'd be happy to if someone could point me in the right direction.

pkg/controllers/uiplugin/components.go

pkg/controllers/uiplugin/plugin_info_builder.go

openshift-ci-robot · 2024-05-17T01:36:26Z

@PeterYurkovich: This pull request references OU-378 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target either version "4.16." or "openshift-4.16.", but it targets "OpenShift 4.16" instead.

In response to this:

This PR addresses OU-378 and OU-314 and looks to add the Troubleshooting Panel console plugin and distributed tracing console plugin to the observability operator.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-05-17T01:38:03Z

@PeterYurkovich: This pull request references OU-314 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.16.0" version, but no target version was set.

In response to this:

This PR addresses OU-378 and OU-314 and looks to add the Troubleshooting Panel console plugin and distributed tracing console plugin to the observability operator.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-05-21T18:31:06Z

@PeterYurkovich: This pull request references OU-314 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

This PR addresses looks to address OU-378, OU-314, OU-423, andCOO-64. It adds the troubleshooting panel console plugin and distributed tracing console plugin to the observability operator.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-05-21T18:31:15Z

@PeterYurkovich: This pull request references OU-314 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.17.0" version, but no target version was set.

In response to this:

This PR addresses looks to address OU-378, OU-314, OU-423, and COO-64. It adds the troubleshooting panel console plugin and distributed tracing console plugin to the observability operator.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-05-22T13:38:38Z

@PeterYurkovich: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

In response to this:

This PR addresses looks to address OU-378, OU-314, OU-423, and COO-64. It adds the troubleshooting panel console plugin and distributed tracing console plugin to the observability operator.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

danielmellado · 2024-06-05T05:55:19Z

/ok-to-test

danielmellado · 2024-06-05T07:53:54Z

/lgtm

danielmellado · 2024-06-05T07:54:04Z

/hold

danielmellado · 2024-06-05T07:55:18Z

@tremes @simonpasquier this lgtm now but I'd like another set of eyes, holding until then!

periklis · 2024-06-05T08:21:34Z

docs/user-guides/observability-ui-plugins.md

+
+### Troubleshooting Panel
+
+The plugin will connect to a Korrel8r instance named `korrel8r` in the `korrel8r` namespace. A "Troubleshooting Panel" button is added to the alerts page, which will convert the current alert into a Korrel8r query, then retrieve related neighbors and display them in a topology view.


This is not accurate but can be changed with #497 by @shwetaap

Changed it in the PR #497

periklis · 2024-06-05T08:22:31Z

pkg/apis/uiplugin/v1alpha1/types.go

+	// korrel8r defines the Korrel8r instance that the troubleshooting panel plugin will connect to
+	//
+	// +optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Korrel8r Instance"
+	Korrel8r TroubleshootingPanelKorrel8rConfig `json:"korrel8r,omitempty"`


Again not accurate when #497 lands because we can eliminate this field and the struct below. (cc @shwetaap )

Removed this in PR #497

pkg/apis/uiplugin/v1alpha1/types.go

pkg/controllers/uiplugin/compatibility_matrix_test.go

danielmellado · 2024-06-05T12:23:25Z

/unhold

danielmellado · 2024-06-05T12:23:31Z

/approve

openshift-ci · 2024-06-05T12:25:33Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danielmellado, periklis, PeterYurkovich, tremes

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [danielmellado]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

simonpasquier

Sorry for the late review. My comments weren't meant to be blocking but it'd be good to address sooner than later.

simonpasquier · 2024-06-05T12:26:23Z

pkg/apis/uiplugin/v1alpha1/types.go

+	//
+	// +optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Korrel8r Instance Name"
+	Name string `json:"name,omitempty"`


Should it really be optional?

Reading the code we assume a default value of "korrel8r" for both but I'd rather make these fields mandatory to be explicit.

The korrel8r deployment is being attached to the troubleshooting panel UIPlugin in #497 so this specific comment might be helpful to address in that PR.

"Korrel8r" will always be deployed when the Troubleshooting Panel is installed in the same namespace where the observability-operator is installed. So there is no need for any configuration.

Removed it in #497

simonpasquier · 2024-06-05T12:30:21Z

pkg/apis/uiplugin/v1alpha1/types.go

+	// TroubleshootingPanel contains configuration for the troubleshooting console plugin.
+	//
+	// +kubebuilder:validation:Optional
+	TroubleshootingPanel *TroubleshootingPanelConfig `json:"troubleshootingPanel,omitempty"`


Similar to what's being done in #477 we need some additional validation to ensure that when type != TroubleshootingPanel, this field isn't defined.
And if we make TroubleshootingPanelKorrel8rConfig a mandatory field, it should be validated too.

I've created a jira for visibility and will make a follow up PR to address these.

simonpasquier · 2024-06-05T12:30:51Z

pkg/apis/uiplugin/v1alpha1/types.go

+	// DistributedTracing contains configuration for the distributed tracing console plugin.
+	//
+	// +kubebuilder:validation:Optional
+	DistributedTracing *DistributedTracingConfig `json:"distributedTracing,omitempty"`


same remark here, we need to check the type to enforce that the field isn't defined when type != DistributedTracing

I've created a jira for visibility and will make a follow up PR to address these.

…obs#480)

PeterYurkovich requested a review from a team as a code owner May 9, 2024 21:18

PeterYurkovich requested review from jan--f and slashpai and removed request for a team May 9, 2024 21:18

openshift-ci-robot added the jira/valid-reference label May 9, 2024

openshift-ci bot requested review from danielmellado and lihongyan1 May 9, 2024 21:18

openshift-ci bot added the needs-ok-to-test label May 9, 2024

PeterYurkovich changed the title ~~OU-378: Add Troubleshooting Panel~~ OU-378: Add UIPlugin for Troubleshooting Panel May 10, 2024

jgbernalp reviewed May 13, 2024

View reviewed changes

PeterYurkovich marked this pull request as draft May 13, 2024 14:28

openshift-ci bot added the do-not-merge/work-in-progress label May 13, 2024

PeterYurkovich changed the title ~~OU-378: Add UIPlugin for Troubleshooting Panel~~ OU-378: Add UIPlugin for Troubleshooting Panel and Distributed Tracing Console Plugins May 17, 2024

PeterYurkovich marked this pull request as ready for review May 17, 2024 01:37

openshift-ci bot removed the do-not-merge/work-in-progress label May 17, 2024

PeterYurkovich changed the title ~~OU-378: Add UIPlugin for Troubleshooting Panel and Distributed Tracing Console Plugins~~ OU-378 OU-314: Add UIPlugin for Troubleshooting Panel and Distributed Tracing Console Plugins May 17, 2024

PeterYurkovich force-pushed the ou-378-add-troubleshooting-panel branch 3 times, most recently from 03dd41c to 8e8c731 Compare May 21, 2024 18:09

PeterYurkovich force-pushed the ou-378-add-troubleshooting-panel branch 2 times, most recently from de84a0d to f5ebcf9 Compare May 22, 2024 13:30

PeterYurkovich changed the title ~~OU-378 OU-314: Add UIPlugin for Troubleshooting Panel and Distributed Tracing Console Plugins~~ feat: add troubleshooting panel and distributed tracing ui-plugin May 22, 2024

openshift-ci-robot removed the jira/valid-reference label May 22, 2024

feat: add distributed tracing and troubleshooting panel uiplugins

11ae0af

PeterYurkovich force-pushed the ou-378-add-troubleshooting-panel branch from b32f71f to 11ae0af Compare June 4, 2024 15:00

PeterYurkovich requested a review from tremes June 4, 2024 19:40

openshift-ci bot added ok-to-test and removed needs-ok-to-test labels Jun 5, 2024

openshift-ci bot assigned danielmellado Jun 5, 2024

openshift-ci bot added the lgtm label Jun 5, 2024

openshift-ci bot added the do-not-merge/hold label Jun 5, 2024

periklis requested changes Jun 5, 2024

View reviewed changes

openshift-ci bot assigned periklis Jun 5, 2024

openshift-ci bot removed the lgtm label Jun 5, 2024

periklis approved these changes Jun 5, 2024

View reviewed changes

openshift-ci bot added the lgtm label Jun 5, 2024

tremes approved these changes Jun 5, 2024

View reviewed changes

openshift-ci bot assigned tremes Jun 5, 2024

openshift-ci bot removed the do-not-merge/hold label Jun 5, 2024

openshift-ci bot added the approved label Jun 5, 2024

danielmellado approved these changes Jun 5, 2024

View reviewed changes

openshift-merge-bot bot merged commit db0b62f into rhobs:main Jun 5, 2024
11 checks passed

simonpasquier reviewed Jun 5, 2024

View reviewed changes

shwetaap pushed a commit to shwetaap/observability-operator that referenced this pull request Jun 5, 2024

feat: add distributed tracing and troubleshooting panel uiplugins (rh…

0b918a8

…obs#480)

shwetaap pushed a commit to shwetaap/observability-operator that referenced this pull request Jun 5, 2024

feat: add distributed tracing and troubleshooting panel uiplugins (rh…

b538491

…obs#480)

PeterYurkovich mentioned this pull request Jun 5, 2024

COO-178: fix: prevent other plugin types from using dynamic tracing and troubleshooting panel configurations #498

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

COO-169: feat: add troubleshooting panel and distributed tracing ui-plugin #480

COO-169: feat: add troubleshooting panel and distributed tracing ui-plugin #480

PeterYurkovich commented May 9, 2024 •

edited

openshift-ci-robot commented May 9, 2024 •

edited by openshift-ci bot

openshift-ci bot commented May 9, 2024

jgbernalp May 13, 2024

PeterYurkovich May 14, 2024 •

edited

openshift-ci-robot commented May 17, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 17, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 22, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

periklis Jun 5, 2024

shwetaap Jun 6, 2024

periklis Jun 5, 2024

shwetaap Jun 6, 2024 •

edited

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

openshift-ci bot commented Jun 5, 2024

simonpasquier left a comment

simonpasquier Jun 5, 2024

PeterYurkovich Jun 5, 2024

shwetaap Jun 6, 2024

shwetaap Jun 6, 2024

simonpasquier Jun 5, 2024

PeterYurkovich Jun 5, 2024

simonpasquier Jun 5, 2024

PeterYurkovich Jun 5, 2024


		### Troubleshooting Panel

		The plugin will connect to a Korrel8r instance named `korrel8r` in the `korrel8r` namespace. A "Troubleshooting Panel" button is added to the alerts page, which will convert the current alert into a Korrel8r query, then retrieve related neighbors and display them in a topology view.

COO-169: feat: add troubleshooting panel and distributed tracing ui-plugin #480

COO-169: feat: add troubleshooting panel and distributed tracing ui-plugin #480

Conversation

PeterYurkovich commented May 9, 2024 • edited

openshift-ci-robot commented May 9, 2024 • edited by openshift-ci bot

openshift-ci bot commented May 9, 2024

Choose a reason for hiding this comment

PeterYurkovich May 14, 2024 • edited

Choose a reason for hiding this comment

openshift-ci-robot commented May 17, 2024 • edited by openshift-ci bot

openshift-ci-robot commented May 17, 2024 • edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 • edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 • edited by openshift-ci bot

openshift-ci-robot commented May 22, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shwetaap Jun 6, 2024 • edited

Choose a reason for hiding this comment

danielmellado commented Jun 5, 2024

danielmellado commented Jun 5, 2024

openshift-ci bot commented Jun 5, 2024

simonpasquier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PeterYurkovich commented May 9, 2024 •

edited

openshift-ci-robot commented May 9, 2024 •

edited by openshift-ci bot

PeterYurkovich May 14, 2024 •

edited

openshift-ci-robot commented May 17, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 17, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 •

edited by openshift-ci bot

openshift-ci-robot commented May 21, 2024 •

edited by openshift-ci bot

shwetaap Jun 6, 2024 •

edited