Add annotation to Web Terminals to enable Operator metrics #9752
Conversation
Add DevWorkspace Operator supported annotation 'controller.devfile.io/devworkspace-source' to Web Terminal instances to enable the DevWorkspace Operator to report Web Terminal-specific metrics. Signed-off-by: Angel Misevski <[email protected]>
| @@ -98,6 +99,7 @@ export const newCloudShellWorkSpace = ( | |||
| }, | |||
| annotations: { | |||
| [CLOUD_SHELL_RESTRICTED_ANNOTATION]: 'true', | |||
| [CLOUD_SHELL_SOURCE_ANNOTATION]: 'web-terminal', | |||
There was a problem hiding this comment.
it's going to appear for new instances, but maybe we also should care about existing ones. WDYT?
There was a problem hiding this comment.
I don't think there's any mechanism in place to update Web Terminals after creation, and I don't think it's worth adding for this (especially since 4.8 might result in clean installs of WTO).
There was a problem hiding this comment.
4.8 already happened.
But yeah, we should be good without updating, if we backport it to 4.8 before WTO 1.3
|
/approve |
|
No docs necessary. /label docs-approved |
openshift-ci
bot
added
docs-approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: amisevsk, christianvogt, JPinkney, sleshchenko 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:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
😳 /retest |
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
5 similar comments
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
|
/retest-required Please review the full test history for this PR and help us cut down flakes. |
Description
PR devfile/devworkspace-operator#500 in the DevWorkspace Operator (which supports Web Terminal/CloudShell functionality on the cluster) enables metrics for DevWorkspace custom resources. These metrics are bucketed according to the
controller.devfile.io/devworkspace-sourceannotation, allowing the operator to report metrics such as startup time, failure rate, etc. partitioned based on the tool used to create the CR.This PR adds the
controller.devfile.io/devworkspace-sourceannotation to web terminals so that DevWorkspace Operator metrics can report Web Terminal-specific metrics.Tests are not updated as the annotation is optional and does not impact end-user experience. Metrics are still reported without it, but may be less accurate due to other DevWorkspace CRs being included in the data.