Archived 2023.09.10. Refer to Guidance on Metrics and ResponseMetricsList
Question
A few clarifications on the metrics to be presented via the GetMetrics operation:
- Availability Metrics: As the non functional requirements for availability excludes planned outages, are planned outages also excluded in the metrics data?
- Performance Metrics: Assume that rejected API calls are not included and API calls that result in an Error are included in the performance metric?
- CustomerCount: Is the customer count intended to be the number of unique DH customers with at least one in-force consent contract (irrespective of whether that customer has consented to share data with multiple ADR-Software products)?
Answer
Availability Metrics: do not include planned or scheduled outages. Unscheduled outages and incidents must be counted.
Performance Metrics: your interpretation is correct. Rejected API calls would incorrectly skew performance results. It is still important than when a data holder rejects an API call it does so for valid reasons and it can provide evidence of the reason(s) for rejection.
CustomerCount: this should be the count of active customers with one or more active consents across all ADRs. The definition of an active customer is determined by the data holder - for example, many customers may have more than one active digital identity that can be resolved to a single customer record in a CRM. Other times this is not possible. The data holder should consider the customer count in a similar way to how they currently define the term customer.
See
Comments
2 comments
Hi Jarryd
Just a follow-up question to this:
Performance Metrics: your interpretation is correct. Rejected API calls would incorrectly skew performance results. It is still important than when a data holder rejects an API call it does so for valid reasons and it can provide evidence of the reason(s) for rejection.
Should Rejected API calls (due to traffic thresholds) also be excluded from Average Response Metrics ?
Thanks
Hi Jakub,
Even error responses should still be timely for a client. It is appropriate to include the response time for rejections in the average response metrics.
- James
Please sign in to leave a comment.