Skip to content
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.

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

chore: move from prom-client to OpenTelemetry metrics #1811

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

JessicaJHee
Copy link
Member

@JessicaJHee JessicaJHee commented Oct 22, 2024

Description

Adopts OpenTelemetry metrics for metrics and move away from using prom-client.

This change adds these new Backstage specific metrics:

  • catalog.stitching.duration
  • catalog.stitching.queue.length
  • catalog.stitching.queue.length
  • backend_tasks.task.runs.count
  • backend_tasks.task.runs.duration

However, OpenTelemetry doesn’t collect Node.js specific metrics like nodejs_eventloop_lag_seconds.

  • Note: Node.js specific metrics are WIP in this PR
  • Edit: this has been merged and released, these missing metrics are now included with OpenTelemetry

The application metrics will be exposed at localhost:9464/metrics

The host/process metrics will be exposed at localhost:9463/metrics

Which issue(s) does this PR fix

Please make sure that the following steps are complete:

  • GitHub Actions are completed and successful
  • Unit Tests are updated and passing
  • E2E Tests are updated and passing
  • Documentation is updated if necessary (requirement for new features)
  • Add a screenshot if the change is UX/UI related

Copy link

openshift-ci bot commented Oct 22, 2024

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Copy link
Contributor

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1811!

@JessicaJHee JessicaJHee marked this pull request as ready for review November 8, 2024 19:56
@JessicaJHee JessicaJHee requested a review from a team as a code owner November 8, 2024 19:56
@JessicaJHee JessicaJHee changed the title move from prom-client to OpenTelemetry metrics chore: move from prom-client to OpenTelemetry metrics Nov 8, 2024
Copy link
Contributor

github-actions bot commented Nov 8, 2024

@JessicaJHee
Copy link
Member Author

TODO: need to update monitoring-and-logging.md, will go through this set up & update the docs

docker/Dockerfile Outdated Show resolved Hide resolved
@JessicaJHee JessicaJHee force-pushed the adopt-opentelemetry branch 2 times, most recently from 563dfb5 to ad3afca Compare November 12, 2024 17:22
Copy link
Contributor

Copy link
Contributor

Copy link
Contributor

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarQube Cloud

Copy link
Contributor

@kim-tsao
Copy link
Member

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm label Nov 15, 2024
Copy link

openshift-ci bot commented Nov 15, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kim-tsao

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kim-tsao kim-tsao merged commit 32c9e0b into redhat-developer:main Nov 15, 2024
11 of 13 checks passed
teknaS47 pushed a commit to teknaS47/backstage-showcase that referenced this pull request Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants