Skip to content

[ws-proxy] add some ssh metrics #10179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
May 23, 2022
Merged

[ws-proxy] add some ssh metrics #10179

merged 2 commits into from
May 23, 2022

Conversation

iQQBot
Copy link
Contributor

@iQQBot iQQBot commented May 23, 2022 •
edited
Loading

Description

This PR add some ssh metrics

metrics name description
gitpod_ws_proxy_ssh_connection_count Current number of SSH connection
gitpod_ws_proxy_ssh_attempt_total Total number of SSH attempt

Related Issue(s)

Fixes #

How to test

  1. open this branch in gitpod.io https://gitpod.io/#https://github.com/gitpod-io/gitpod/pull/10179
  2. run ./dev/preview/portforward-monitoring-satellite.sh -c harvester
  3. open a workspace in preview environment
  4. try to connect with this workspace using copy/paste command
  5. try to connect with this workspace using Jetbrains gateway
  6. try to connect with this workspace using copy/paste command inside workspace (Simulate the case where there is no private key)
  7. try to connect ssh gateway using incorrect username and password
  8. ...... Try any other connection you can think of, and see if the three metrics above always reflect the true situation

image
image

Release Notes

Add some ssh connection metrics

Documentation

  • /werft withObservabilityBranch=pd/ssh-metrics

@iQQBot iQQBot mentioned this pull request May 23, 2022
Merged
@iQQBot
Copy link
Contributor Author

iQQBot commented May 23, 2022 •
edited by werft-gitpod-dev-com bot
Loading

/werft run

👍 started the job as gitpod-build-pd-ssh-metrics.5
(with .werft/ from main)

@iQQBot
Copy link
Contributor Author

iQQBot commented May 23, 2022 •
edited by werft-gitpod-dev-com bot
Loading

/werft run

👍 started the job as gitpod-build-pd-ssh-metrics.6
(with .werft/ from main)

@roboquat roboquat added size/L and removed size/M labels May 23, 2022
@iQQBot iQQBot force-pushed the pd/ssh-metrics branch 3 times, most recently from c9cf5ee to 08bc9d2 Compare May 23, 2022 06:03
@iQQBot iQQBot marked this pull request as ready for review May 23, 2022 06:06
@iQQBot iQQBot requested a review from a team May 23, 2022 06:06
@github-actions github-actions bot added the team: workspace Issue belongs to the Workspace team label May 23, 2022
akosyakov
akosyakov reviewed May 23, 2022
View reviewed changes
@iQQBot
Copy link
Contributor Author

iQQBot commented May 23, 2022

@akosyakov is it ready for merge?

@akosyakov
Copy link
Member

@iQQBot it is fine with me, but I'm not a code owner. You need to reach out to the workspace team.

@iQQBot
Copy link
Contributor Author

iQQBot commented May 23, 2022

already do

princerachit
princerachit reviewed May 23, 2022
View reviewed changes
install/installer/pkg/components/ws-proxy/rolebinding.go
@@ -16,6 +16,25 @@ import (

func rolebinding(ctx *common.RenderContext) ([]runtime.Object, error) {
return []runtime.Object{
&rbacv1.ClusterRoleBinding{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, where is this permission being used? I am unsure why we need this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we want use kube-rbac-proxy to serve metrics instead of direct using ws-proxy
just like other components, kube-rbac-proxy need this permission

https://github.com/gitpod-io/gitpod/blob/main/install/installer/pkg/components/ws-daemon/rolebinding.go#L22-L38
https://github.com/gitpod-io/gitpod/blob/main/install/installer/pkg/components/ws-manager/rolebinding.go#L22-L39

@princerachit
Copy link
Contributor

Code looks good but added a clarifying question

@roboquat roboquat merged commit f797fdb into main May 23, 2022
@roboquat roboquat deleted the pd/ssh-metrics branch May 23, 2022 16:20
@iQQBot iQQBot mentioned this pull request May 24, 2022
Merged
@roboquat roboquat added deployed: workspace Workspace team change is running in production deployed Change is completely running in production labels May 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akosyakov akosyakov akosyakov left review comments

@princerachit princerachit princerachit approved these changes

Assignees
No one assigned
Labels
deployed: workspace Workspace team change is running in production deployed Change is completely running in production release-note size/L team: workspace Issue belongs to the Workspace team
Projects
🚀 IDE Team
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@iQQBot @akosyakov @princerachit @roboquat