redhat-developer / redhat-developer/rhdh-plugins

Extend scorecard-backend so that MetricsProviders and Metrics can be optionally disabled by default

Open
#4,586 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement feature triaged workspace/scorecard
Dominant language
TypeScript
Stars
48
Forks
120
Avg merge
2d 6h
Merged PRs (30d)
337

Description

Extend the scorecard-backend and scorecard-commons packages so that MetricsProviders and Metrics can be disabled by default.

  1. There should be an optional function isEnabled in a MetricsProvider: () => boolean and an optional field enabled: boolean in the Metric type. A missing function or field means it's enabled by default.
  2. There should be an optional enabled attribute also in the Config (config.d.ts) for metric providers and metrics to re-enable disable-by-default metrics or to disable specific metric providers or metrics.
  3. the backend should ignore disabled metric providers and metrics. Old data should stay in the database. When there are calls that return metrics just based on the database, they should check if the metric is enabled or not.

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 scorecard-backend and scorecard-commons packages, including config.d.ts, and trace MetricsProvider, Metric, and database-backed metric-returning calls. Confirm how configuration is loaded and where providers and metrics are selected. Done means optional defaults and configuration overrides work, disabled items are ignored, and existing database data remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend, databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.