OpenBankProject / OpenBankProject/OBP-API
feature: add cache to Metric endpoints
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 482
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 15
Description
In order to reduce frequently query metrics related db table, add cache to metrics endpoints.
Accept criteria:
- Get Aggregate Metrics
- Get Connector Metrics
- Get Metrics
- Get Top APIs
- Get Top Consumers
questions:
- "Search API Metrics via Elasticsearch" also need add cache?
- If it is ok to add cache to MappedMetrics object? or add to ApiMethods300.scala?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Metric endpoint implementations, the MappedMetrics object, and ApiMethods300.scala, then trace how the five listed endpoints query the metrics database. Check how the Elasticsearch metrics search fits into the scope and determine where caching belongs. Done means the caching scope and placement are resolved for all five accepted endpoints, with the Elasticsearch question addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch, scala
- Domain
- api, backend, performance
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100