IDE metrics server

[iQQBot]

Description

This PR introduce a new component ide-metrics, which is a public endpoint, which can allow some short live client report metrics and error log (not in this PR)

Related Issue(s)

Fix #11134

How to test

For test convenience I wrote some test clients, and they will be deleted before merge

1. open this branch in gitpod.io
2. switch to /workspace/gitpod/components/ide-metrics
3. run go run main.go test-client, you will see send success message
4. use ./dev/preview/portforward-monitoring-satellite.sh -c harvester to open promethues
5. you will see the metrics gitpod_supervisor_frontend_error_total is increase (There is an interval for scraping, you can refresh in 1min)

another example:

1. open workspace in preview environment
2. open chrome dev tool -> Console
3. run command throw new Error("aa"), them switch to Network tab, you will see AddCounter request
4. monitor promethues metrics gitpod_supervisor_frontend_error_total should increase
   

Release Notes

NONE

Documentation

Werft options:

• /werft with-preview
• /werft publish-to-npm
• /werft withObservabilityBranch=pd/ide-metrics

[socket-security]

Socket Security Report

👍 No new dependency issues detected in pull request

Socket.dev scan summary

Issue	Status
Did you mean?	✅ no new possible package typos
Install scripts	✅ no new install scripts
Telemetry	✅ no new telemetry
Troll package	✅ no new troll packages
Malware	✅ no new malware
Native code	✅ no new native modules

Powered by socket.dev

[werft-gitpod-dev-com]

started the job as gitpod-build-pd-ide-metrics.10 because the annotations in the pull request description changed
(with .werft/ from main)

[gitguardian]

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them.
Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately.
Find here more information about risks.

---

<sup><sub>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sub></sup>

[iQQBot]

@iQQBot it looks like that's awaiting the @gitpod-io/platform team's approval

Yes, so I put a hold label here, wait https://github.com/gitpod-io/ops/pull/3666 get merged first. Thanks 🙏

[mustard-mh]

I tested manually throw new Error('hello') in DevTool Terminal and it worked well, but errors like the image below seem not been caught?

[akosyakov]

I tested manually throw new Error('hello') in DevTool Terminal and it worked well, but errors like the image below seem not been caught?

@mustard-mh It is alright. The goal of this PR is to bring IDE metrics component to production. We can work on concrete metrics later.

[akosyakov]

@iQQBot let's close #11134 with it

I will create another issue for GCP error reporting. What is left here only rate limitting?

[iQQBot]

@iQQBot let's close #11134 with it

I will create another issue for GCP error reporting. What is left here only rate limitting?

Yes, but I am not sure what do we need to base the rate limit on, IP address?

[akosyakov]

Yes, but I am not sure what do we need to base the rate limit on, IP address?

Could you check how we do it in ws-manager please? 🙏 It can be another PR, let's create an issue for it for now. We need to land this PR to unblock #11910

[iQQBot]

Could you check how we do it in ws-manager please? 🙏 It can be another PR, let's create an issue for it for now. We need to land this PR to unblock #11910

ws-manager just rate limit for the method name https://github.com/gitpod-io/ops/blob/main/deploy/workspace/installer-values.yaml#L25-L32 because it client only server and ws-proxy

[akosyakov]

@iQQBot We can do the same or on level of metric names? but let's do it later, we don't have anyone calling it yet so often, anyway

[iQQBot]

@iQQBot We can do the same or on level of metric names? but let's do it later, we don't have anyone calling it yet so often, anyway

Let's see how it looks in practice and then see how we can adjust ratelimit

[iQQBot]

/unhold