artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 15:27:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

metrics date logging / props parsing

Browse Source
This commit is contained in:
simonredfern 2025-11-23 01:39:48 +01:00
parent 4e5c5a5db8
commit 4a6487cc12
3 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
obp-api/src/main/resources/props/sample.props.template
View File

@ -229,9 +229,16 @@ write_connector_metrics=false
## Metrics Cache Configuration - Smart Two-Tier Caching
## Metrics older than the stable boundary are immutable and can be cached longer
MappedMetrics.cache.ttl.seconds.getAllMetrics=7 # Short TTL for recent/changing data
MappedMetrics.cache.ttl.seconds.getStableMetrics=86400 # 24 hours - Long TTL for stable/old data
MappedMetrics.stable.boundary.seconds=600 # 10 minutes - Metrics older than this are considered stable
# Short TTL for recent/changing data
MappedMetrics.cache.ttl.seconds.getAllMetrics=7
# 24 hours - Long TTL for stable/old data
MappedMetrics.cache.ttl.seconds.getStableMetrics=86400
# 10 minutes - Metrics older than this are considered stable
MappedMetrics.stable.boundary.seconds=600
## You can use a no config needed h2 database by setting db.driver=org.h2.Driver and not including db.url
# See the README for how to use the H2 browser / console.

1
obp-api/src/main/scala/code/api/util/APIUtil.scala
View File

@ -1020,6 +1020,7 @@ object APIUtil extends MdcLoggable with CustomJsonFormats{
}
else
{
logger.warn(s"Failed to parse date string: '$date'. Expected format: ${DateWithMsFormat.toPattern}")
Failure(FilterDateFormatError)
}
}

19
obp-api/src/main/scala/code/api/v6_0_0/APIMethods600.scala
View File

@ -25,13 +25,14 @@ import code.entitlement.Entitlement
import code.model._
import code.ratelimiting.RateLimitingDI
import code.util.Helper
import code.util.Helper.SILENCE_IS_GOLDEN
import code.util.Helper.{MdcLoggable, SILENCE_IS_GOLDEN}
import code.views.Views
import com.github.dwickern.macros.NameOf.nameOf
import com.openbankproject.commons.ExecutionContext.Implicits.global
import com.openbankproject.commons.model.{CustomerAttribute, _}
import com.openbankproject.commons.util.{ApiVersion, ScannedApiVersion}
import net.liftweb.common.{Empty, Full}
import net.liftweb.http.provider.HTTPParam
import net.liftweb.http.rest.RestHelper
import net.liftweb.json.{Extraction, JsonParser}
import net.liftweb.json.JsonAST.JValue
@ -48,7 +49,7 @@ trait APIMethods600 {
val Implementations6_0_0 = new Implementations600()
class Implementations600 {
class Implementations600 extends MdcLoggable {
val implementedInApiVersion: ScannedApiVersion = ApiVersion.v6_0_0
@ -1339,6 +1340,14 @@ trait APIMethods600 {
|
|require CanReadMetrics role
|
|**NOTE: Automatic from_date Default**
|
|If you do not provide a `from_date` parameter, this endpoint will automatically set it to:
|**now - ${(APIUtil.getPropsValue("MappedMetrics.stable.boundary.seconds", "600").toInt - 1) / 60} minutes ago**
|
|This prevents accidentally querying all metrics since Unix Epoch and ensures reasonable response times.
|For historical/reporting queries, always explicitly specify your desired `from_date`.
|
|**IMPORTANT: Smart Caching & Performance**
|
|This endpoint uses intelligent two-tier caching to optimize performance:
@ -1436,16 +1445,16 @@ trait APIMethods600 {
implicit val ec = EndpointContext(Some(cc))
for {
(Full(u), callContext) <- authenticatedAccess(cc)
_ <- NewStyle.function.hasEntitlement("", u.userId, ApiRole.canReadMetrics, callContext)
_ <- NewStyle.function.hasEntitlement("", u.userId, canReadMetrics, callContext)
httpParams <- NewStyle.function.extractHttpParamsFromUrl(cc.url)
// If from_date is not provided, set it to now - (stable.boundary - 1 second)
// This ensures we get recent data with the shorter cache TTL
httpParamsWithDefault = {
val hasFromDate = httpParams.exists(p => p.name == "from_date" || p.name == "obp_from_date")
if (!hasFromDate) {
val stableBoundarySeconds = APIUtil.getPropsValue("MappedMetrics.stable.boundary.seconds", "600").toInt
val stableBoundarySeconds = APIUtil.getPropsAsIntValue("MappedMetrics.stable.boundary.seconds", 600)
val defaultFromDate = new java.util.Date(System.currentTimeMillis() - ((stableBoundarySeconds - 1) * 1000L))
val dateStr = APIUtil.DateWithMs.format(defaultFromDate)
val dateStr = APIUtil.DateWithMsFormat.format(defaultFromDate)
HTTPParam("from_date", List(dateStr)) :: httpParams
} else {
httpParams