cloudfoundry / cloudfoundry/bosh

`/metrics` and `/api_metrics` endpoint does not show the generic API metrics for the director's endpoints

Open
#2,467 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.1k
Forks
662
Avg merge
5h 25m
Merged PRs (30d)
2

Description

Describe the bug
According to documentation the /metrics and /api_metrics endpoint will expose the generic API metrics for the director's endpoints including number of requests and response time. But when we call those endpoints:

  1. /metrics only exposes the metrics for /metrics and /api_metrics endpoints
  2. /api_metrics only return OK

To Reproduce

  1. Deploy a bosh director
  2. curl some endpoints of bosh, e.g. vms, deployments, etc.
  3. curl http://<bosh_ip>:9092/metrics
  4. curl curl http://<bosh_ip>:9092/api_metrics

Expected behavior
The endpoint should return metrics of bosh endpoints.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked Director metrics documentation and reproducing the requests against /metrics and /api_metrics after calling endpoints such as vms and deployments. Compare the returned metrics with the documented generic request count and response-time behavior; done means both endpoints expose metrics for the Director API endpoints rather than only their own requests or an empty OK response.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, observability
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.