Skip to content

Commit

Permalink
adds promethues metric tracking for functionActivator validate & publ…
Browse files Browse the repository at this point in the history 
…ishToSandbox (finos#2911)

Co-authored-by: sameer saini <[email protected]>
  • Loading branch information
@rafaelbey @sameersaini
rafaelbey and sameersaini authored Jun 14, 2024
1 parent 29f2aab commit a128ab5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .../src/main/java/org/finos/legend/engine/shared/core/operational/logs/LoggingEventType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -390,4 +390,7 @@ public enum LoggingEventType implements ILoggingEventType

TEST_DATA_GENERATION_ERROR,
RUN_TEST_ERROR,

FUNCTION_ACTIVATOR_VALIDATE_ERROR,
FUNCTION_ACTIVATOR_PUBLISHTOSANDBOX_ERROR
}
25 changes: 21 additions & 4 deletions ...api/src/main/java/org/finos/legend/engine/functionActivator/api/FunctionActivatorAPI.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.eclipse.collections.api.list.MutableList;
import org.finos.legend.engine.functionActivator.api.input.FunctionActivatorInput;
import org.finos.legend.engine.functionActivator.api.output.FunctionActivatorInfo;
import org.finos.legend.engine.functionActivator.service.FunctionActivatorError;
import org.finos.legend.engine.protocol.functionActivator.deployment.FunctionActivatorDeploymentConfiguration;
import org.finos.legend.engine.functionActivator.service.FunctionActivatorLoader;
import org.finos.legend.engine.functionActivator.service.FunctionActivatorService;
Expand All @@ -41,15 +42,19 @@
import org.finos.legend.engine.shared.core.kerberos.ProfileManagerHelper;
import org.finos.legend.engine.shared.core.operational.errorManagement.ExceptionTool;
import org.finos.legend.engine.shared.core.operational.logs.LoggingEventType;
import org.finos.legend.engine.shared.core.operational.prometheus.MetricsHandler;
import org.finos.legend.engine.shared.core.operational.prometheus.Prometheus;
import org.finos.legend.pure.generated.Root_meta_external_function_activator_FunctionActivator;
import org.finos.legend.pure.generated.Root_meta_pure_extension_Extension;
import org.pac4j.core.profile.CommonProfile;
import org.pac4j.core.profile.ProfileManager;
import org.pac4j.jax.rs.annotations.Pac4JProfileManager;

import javax.ws.rs.*;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

import java.util.List;

Expand Down Expand Up @@ -99,21 +104,27 @@ public Response list(@ApiParam(hidden = true) @Pac4JProfileManager ProfileManage
@ApiOperation(value = "Validate that the functions can be properly activated by the activator.")
@Consumes({MediaType.APPLICATION_JSON, APPLICATION_ZLIB})
@Produces(MediaType.APPLICATION_JSON)
public Response validate(FunctionActivatorInput input, @ApiParam(hidden = true) @Pac4JProfileManager ProfileManager<CommonProfile> pm)
@Prometheus(name = "FunctionActivator validate", doc = "Function Activator validate duration histogram")
public Response validate(FunctionActivatorInput input, @ApiParam(hidden = true) @Pac4JProfileManager ProfileManager<CommonProfile> pm, @Context UriInfo uriInfo)
{
MutableList<CommonProfile> profiles = ProfileManagerHelper.extractProfiles(pm);
Identity identity = Identity.makeIdentity(profiles);
try
{
long start = System.currentTimeMillis();
String clientVersion = input.clientVersion == null ? PureClientVersions.production : input.clientVersion;
PureModel pureModel = modelManager.loadModel(input.model, clientVersion, identity, null);
Root_meta_external_function_activator_FunctionActivator activator = (Root_meta_external_function_activator_FunctionActivator) pureModel.getPackageableElement(input.functionActivator);
FunctionActivatorService<Root_meta_external_function_activator_FunctionActivator, FunctionActivatorDeploymentConfiguration, DeploymentResult> service = getActivatorService(activator, pureModel);
return Response.ok(objectMapper.writeValueAsString(service.validate(Identity.makeIdentity(profiles), pureModel, activator, input.model, routerExtensions))).type(MediaType.APPLICATION_JSON_TYPE).build();
MutableList<? extends FunctionActivatorError> validate = service.validate(Identity.makeIdentity(profiles), pureModel, activator, input.model, routerExtensions);
long end = System.currentTimeMillis();
MetricsHandler.observeRequest(uriInfo != null ? uriInfo.getPath() : null, start, end);
return Response.ok(objectMapper.writeValueAsString(validate)).type(MediaType.APPLICATION_JSON_TYPE).build();
}
catch (Exception ex)
{
ex.printStackTrace();
MetricsHandler.observeError(LoggingEventType.FUNCTION_ACTIVATOR_VALIDATE_ERROR, ex, null);
return ExceptionTool.exceptionManager(ex, LoggingEventType.CATCH_ALL, identity.getName());
}
}
Expand All @@ -123,21 +134,27 @@ public Response validate(FunctionActivatorInput input, @ApiParam(hidden = true)
@ApiOperation(value = "Public the activator to a sandbox environment. Production deployment will occur using the SDLC pipeline.")
@Consumes({MediaType.APPLICATION_JSON, APPLICATION_ZLIB})
@Produces(MediaType.APPLICATION_JSON)
public Response publishToSandbox(FunctionActivatorInput input, @ApiParam(hidden = true) @Pac4JProfileManager ProfileManager<CommonProfile> pm)
@Prometheus(name = "FunctionActivator publishToSandbox", doc = "Function Activator publishToSandbox duration histogram")
public Response publishToSandbox(FunctionActivatorInput input, @ApiParam(hidden = true) @Pac4JProfileManager ProfileManager<CommonProfile> pm, @Context UriInfo uriInfo)
{
MutableList<CommonProfile> profiles = ProfileManagerHelper.extractProfiles(pm);
Identity identity = Identity.makeIdentity(profiles);
try
{
long start = System.currentTimeMillis();
String clientVersion = input.clientVersion == null ? PureClientVersions.production : input.clientVersion;
PureModel pureModel = modelManager.loadModel(input.model, clientVersion, identity, null);
Root_meta_external_function_activator_FunctionActivator activator = (Root_meta_external_function_activator_FunctionActivator) pureModel.getPackageableElement(input.functionActivator);
FunctionActivatorService<Root_meta_external_function_activator_FunctionActivator, FunctionActivatorDeploymentConfiguration, DeploymentResult> service = getActivatorService(activator,pureModel);
return Response.ok(objectMapper.writeValueAsString(service.publishToSandbox(Identity.makeIdentity(profiles), pureModel, activator, input.model, service.selectConfig(this.runtimeDeploymentConfig), routerExtensions))).type(MediaType.APPLICATION_JSON_TYPE).build();
DeploymentResult deploymentResult = service.publishToSandbox(Identity.makeIdentity(profiles), pureModel, activator, input.model, service.selectConfig(this.runtimeDeploymentConfig), routerExtensions);
long end = System.currentTimeMillis();
MetricsHandler.observeRequest(uriInfo != null ? uriInfo.getPath() : null, start, end);
return Response.ok(objectMapper.writeValueAsString(deploymentResult)).type(MediaType.APPLICATION_JSON_TYPE).build();
}
catch (Exception ex)
{
ex.printStackTrace();
MetricsHandler.observeError(LoggingEventType.FUNCTION_ACTIVATOR_PUBLISHTOSANDBOX_ERROR, ex, null);
return ExceptionTool.exceptionManager(ex, LoggingEventType.CATCH_ALL, identity.getName());
}
}
Expand Down
4 changes: 2 additions & 2 deletions ...p-api/src/test/java/org/finos/legend/engine/language/snowflakeApp/api/TestValidation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public void testProperPlan()
" ownership : Deployment { identifier: 'ownership' };" +
" function: a::f():TabularDataSet[1];" +
"}";
Response response = api.validate(new FunctionActivatorInput("vX_X_X", "a::myApp", PureGrammarParser.newInstance().parseModel(val)), null);
Response response = api.validate(new FunctionActivatorInput("vX_X_X", "a::myApp", PureGrammarParser.newInstance().parseModel(val)), null, null);
Assert.assertEquals("[]", response.getEntity().toString());
}

Expand All @@ -75,7 +75,7 @@ public void testImproperPlan()
" ownership : Deployment { identifier: 'ownership' };" +
" function: a::f():Person[*];" +
"}";
Response response = api.validate(new FunctionActivatorInput("vX_X_X", "a::myApp", PureGrammarParser.newInstance().parseModel(val)), null);
Response response = api.validate(new FunctionActivatorInput("vX_X_X", "a::myApp", PureGrammarParser.newInstance().parseModel(val)), null, null);
Assert.assertEquals("[{\"foundSQLs\":[],\"message\":\"SnowflakeApp can't be used with a plan containing '0' SQL expressions\"}]", response.getEntity().toString());
}

Expand Down

0 comments on commit a128ab5

Please sign in to comment.