Skip to content

FINERACT-2438: Add Micrometer Observability to Reporting API #5348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shivd131 wants to merge 1 commit into
base: develop
Choose a base branch
from
+34 −11
Open

FINERACT-2438: Add Micrometer Observability to Reporting API #5348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 32 additions & 9 deletions ...c/main/java/org/apache/fineract/infrastructure/dataqueries/api/RunreportsApiResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
*/
package org.apache.fineract.infrastructure.dataqueries.api;

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Timer;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.ArraySchema;
Expand Down Expand Up @@ -63,6 +65,7 @@ public class RunreportsApiResource {
private final PlatformSecurityContext context;
private final ReadReportingService readExtraDataAndReportingService;
private final ReportingProcessServiceProvider reportingProcessServiceProvider;
private final MeterRegistry meterRegistry;

@GET
@Path("/availableExports/{reportName}")
Expand Down Expand Up @@ -134,23 +137,43 @@ public Response runReport(final String reportName, final UriInfo uriInfo, final
}

private Response processReportRequest(final String reportName, final UriInfo uriInfo, final boolean isSelfServiceUserReport) {
Timer.Sample sample = Timer.start(meterRegistry);
MultivaluedMap<String, String> queryParams = new MultivaluedStringMap();
queryParams.putAll(uriInfo.getQueryParameters());

final boolean parameterTypeValue = ApiParameterHelper.parameterType(queryParams);

checkUserPermissionForReport(reportName, parameterTypeValue);
String outputType = queryParams.getFirst("output-type");
if (outputType == null) {
outputType = "HTML";
}

// Pass through isSelfServiceUserReport so that ReportingProcessService implementations can use it
queryParams.putSingle(IS_SELF_SERVICE_USER_REPORT_PARAMETER, Boolean.toString(isSelfServiceUserReport));
try {
checkUserPermissionForReport(reportName, parameterTypeValue);

String reportType = readExtraDataAndReportingService.getReportType(reportName, isSelfServiceUserReport, parameterTypeValue);
ReportingProcessService reportingProcessService = reportingProcessServiceProvider.findReportingProcessService(reportType);
if (reportingProcessService == null) {
throw new PlatformServiceUnavailableException("err.msg.report.service.implementation.missing",
ReportingProcessServiceProvider.SERVICE_MISSING + reportType, reportType);
queryParams.putSingle(IS_SELF_SERVICE_USER_REPORT_PARAMETER, Boolean.toString(isSelfServiceUserReport));

String reportType = readExtraDataAndReportingService.getReportType(reportName, isSelfServiceUserReport, parameterTypeValue);
ReportingProcessService reportingProcessService = reportingProcessServiceProvider.findReportingProcessService(reportType);
if (reportingProcessService == null) {
throw new PlatformServiceUnavailableException("err.msg.report.service.implementation.missing",
ReportingProcessServiceProvider.SERVICE_MISSING + reportType, reportType);
}

Response response = reportingProcessService.processRequest(reportName, queryParams);

// 2. Stop Timer (Success)
sample.stop(Timer.builder("fineract.report.execution").tag("name", reportName).tag("type", reportType).tag("format", outputType)
.tag("status", "success").register(meterRegistry));

return response;

} catch (Exception e) {
// 3. Stop Timer (Failure)
sample.stop(Timer.builder("fineract.report.execution").tag("name", reportName).tag("format", outputType).tag("status", "failed")
.tag("exception", e.getClass().getSimpleName()).register(meterRegistry));
throw e;
}
return reportingProcessService.processRequest(reportName, queryParams);
}

private void checkUserPermissionForReport(final String reportName, final boolean parameterType) {
Expand Down
4 changes: 2 additions & 2 deletions fineract-provider/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,8 +339,8 @@ management.endpoints.web.cors.allowed-headers=*

# FINERACT-883
management.info.git.mode=FULL
management.endpoints.web.exposure.include=${FINERACT_MANAGEMENT_ENDPOINT_WEB_EXPOSURE_INCLUDE:health,info,prometheus}

management.endpoints.web.exposure.include=${FINERACT_MANAGEMENT_ENDPOINT_WEB_EXPOSURE_INCLUDE:health,info,metrics,prometheus}
management.endpoint.metrics.enabled=${FINERACT_MANAGEMENT_ENDPOINT_METRICS_ENABLED:false}
management.tracing.enabled=${FINERACT_MANAGEMENT_TRACIING_ENABLED:false}

management.metrics.tags.application=${FINERACT_MANAGEMENT_METRICS_TAGS_APPLICATION:fineract}
Expand Down