jayblanc commented on code in PR #698: URL: https://github.com/apache/unomi/pull/698#discussion_r1794832347
########## extensions/healthcheck/src/main/java/org/apache/unomi/healthcheck/provider/PersistenceHealthCheckProvider.java: ########## @@ -0,0 +1,78 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.unomi.healthcheck.provider; + +import org.apache.unomi.api.PropertyType; +import org.apache.unomi.healthcheck.HealthCheckResponse; +import org.apache.unomi.healthcheck.HealthCheckProvider; +import org.apache.unomi.persistence.spi.PersistenceService; +import org.osgi.service.component.annotations.Component; +import org.osgi.service.component.annotations.Reference; +import org.osgi.service.component.annotations.ReferenceCardinality; +import org.osgi.service.component.annotations.ReferencePolicy; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A health check that track the Unomi persistence layer availability. An evolution would be to check the persistence migration status to + * ensure that running instance is aligned with the underlying persistence migration status and structures. + */ +@Component(service = HealthCheckProvider.class, immediate = true) +public class PersistenceHealthCheckProvider implements HealthCheckProvider { + + private static final Logger LOGGER = LoggerFactory.getLogger(PersistenceHealthCheckProvider.class.getName()); + public static final String NAME = "persistence"; + + @Reference(service = PersistenceService.class, cardinality = ReferenceCardinality.OPTIONAL, policy = ReferencePolicy.DYNAMIC, bind = "bind", unbind = "unbind") + private volatile PersistenceService service; + + public PersistenceHealthCheckProvider() { + LOGGER.info("Building persistence health provider service..."); + } + + public void bind(PersistenceService service) { + this.service = service; + } + + public void unbind(PersistenceService service) { + this.service = null; + } + + @Override public String name() { + return NAME; + } + + @Override public HealthCheckResponse execute() { + LOGGER.debug("Health check persistence"); + HealthCheckResponse.Builder builder = new HealthCheckResponse.Builder(); + builder.name(NAME).down(); + try { + if (service != null) { + builder.up(); + //TODO replace by the expected persistence version when migrations steps will be stored in the persistence service + if (!service.query("target", "profiles", null, PropertyType.class).isEmpty()) { Review Comment: This check is only to validate the Peristence layer of unomi and the. This is a Service of unomi so when not started, that service is not available. It is not about elasticsearch or content presence. Thus it is not loading profiles but only PropertyType related to profiles. It is the smallest request I found to check that the persistence layer (aka ORM) is configured and works as expected. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
