org.openremote.manager.syslog.SyslogService Maven / Gradle / Ivy
/*
* Copyright 2017, OpenRemote Inc.
*
* See the CONTRIBUTORS.txt file in the distribution for a
* full listing of individual contributors.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see batch = new ArrayList<>();
protected ScheduledFuture flushBatchFuture;
protected ScheduledFuture deleteOldFuture;
@Override
public int getPriority() {
return ContainerService.DEFAULT_PRIORITY;
}
@Override
public void init(Container container) throws Exception {
scheduledExecutorService = container.getScheduledExecutor();
if (container.hasService(ClientEventService.class) && container.hasService(PersistenceService.class)) {
LOG.info("Syslog service enabled");
clientEventService = container.getService(ClientEventService.class);
persistenceService = container.getService(PersistenceService.class);
} else {
LOG.info("Syslog service disabled, missing required services");
}
if (clientEventService != null) {
clientEventService.addSubscriptionAuthorizer((realm, auth, subscription) ->
subscription.isEventType(SyslogEvent.class) && auth != null && (auth.isSuperUser() || auth.hasResourceRole(Constants.READ_LOGS_ROLE, Constants.KEYCLOAK_CLIENT_ID)));
}
if (container.hasService(ManagerWebService.class)) {
container.getService(ManagerWebService.class).addApiSingleton(
new SyslogResourceImpl(this)
);
}
int maxAgeDays = MapAccess.getInteger(container.getConfig(), OR_SYSLOG_MAX_AGE_DAYS, OR_SYSLOG_MAX_AGE_DAYS_DEFAULT);
SyslogLevel syslogLevel = Optional.ofNullable(MapAccess.getString(container.getConfig(), OR_SYSLOG_LOG_LEVEL, null)).map(SyslogLevel::valueOf).orElse(OR_SYSLOG_LOG_LEVEL_DEFAULT);
config = new SyslogConfig(syslogLevel, SyslogCategory.values(), maxAgeDays * 24 * 60);
}
@Override
public void start(Container container) throws Exception {
if (persistenceService != null) {
TimerService timerService = container.getService(TimerService.class);
// Flush batch every 3 seconds (wait 10 seconds for database (schema) to be ready in dev mode)
flushBatchFuture = scheduledExecutorService.scheduleAtFixedRate(this::flushBatch, 10, 3, TimeUnit.SECONDS);
// Clear outdated events once a day
if (config.getStoredMaxAgeMinutes() > 0) {
// Schedule purge at approximately 3AM daily
long initialDelay = ChronoUnit.MILLIS.between(
timerService.getNow(),
timerService.getNow().truncatedTo(DAYS).plus(27, ChronoUnit.HOURS));
deleteOldFuture = scheduledExecutorService.scheduleAtFixedRate(
this::purgeSyslog,
initialDelay,
Duration.ofDays(1).toMillis(), TimeUnit.MILLISECONDS
);
}
}
}
protected void purgeSyslog() {
try {
persistenceService.doTransaction(em -> em.createQuery(
"delete from SyslogEvent e " +
"where e.timestamp <= :date")
.setParameter("date",
Date.from(Instant.now().minus(config.getStoredMaxAgeMinutes(), ChronoUnit.MINUTES)))
.executeUpdate());
} catch (Throwable e) {
LOG.log(Level.WARNING, "Failed to purge syslog events", e);
}
}
@Override
public void stop(Container container) throws Exception {
if (flushBatchFuture != null) {
flushBatchFuture.cancel(true);
flushBatchFuture = null;
}
if (deleteOldFuture != null) {
deleteOldFuture.cancel(true);
deleteOldFuture = null;
}
}
@Override
public void flush() {
}
@Override
public void close() throws SecurityException {
}
@Override
public void publish(LogRecord record) {
SyslogEvent syslogEvent = SyslogCategory.mapSyslogEvent(record);
if (syslogEvent != null) {
try {
store(syslogEvent);
} catch (Exception e) {
LOG.log(Level.SEVERE, "Failed to store syslog event", e);
}
try {
if (clientEventService != null)
clientEventService.publishEvent(syslogEvent);
} catch (Exception e) {
LOG.log(Level.SEVERE, "Failed to send syslog event to subscribed clients", e);
}
}
}
public void setConfig(SyslogConfig config) {
synchronized (batch) {
LOG.info("Using: " + config);
this.config = config;
}
}
public SyslogConfig getConfig() {
synchronized (batch) {
return config;
}
}
public void clearStoredEvents() {
if (persistenceService == null)
return;
synchronized (batch) {
persistenceService.doTransaction(em -> em.createQuery("delete from SyslogEvent e").executeUpdate());
}
}
public Pair> getEvents(SyslogLevel level, int perPage, int page, Instant from, Instant to, List categories, List subCategories) {
if (persistenceService == null)
return null;
if (to == null) {
to = Instant.now();
}
if (from == null) {
from = to.minus(1, ChronoUnit.HOURS);
}
Date fromDate = Date.from(from);
Date toDate = Date.from(to);
AtomicLong count = new AtomicLong();
List events = persistenceService.doReturningTransaction(em -> {
StringBuilder sb = new StringBuilder("from SyslogEvent e where e.timestamp >= :from and e.timestamp <= :to");
if (level != null) {
sb.append(" and e.level >= :level");
}
if (categories != null && !categories.isEmpty()) {
sb.append(" and e.category in :categories");
}
if (subCategories != null && !subCategories.isEmpty()) {
sb.append(" and e.subCategory in :subCategories");
}
TypedQuery countQuery = em.createQuery("select count(e.id) " + sb.toString(), Long.class);
countQuery.setParameter("from", fromDate);
countQuery.setParameter("to", toDate);
if (level != null) {
countQuery.setParameter("level", level);
}
if (categories != null && !categories.isEmpty()) {
countQuery.setParameter("categories", categories);
}
if (subCategories != null && !subCategories.isEmpty()) {
countQuery.setParameter("subCategories", subCategories);
}
count.set(countQuery.getSingleResult());
if (count.get() == 0L) {
return Collections.emptyList();
}
sb.append(" order by e.timestamp desc");
TypedQuery query = em.createQuery("select e " + sb.toString(), SyslogEvent.class);
query.setParameter("from", fromDate);
query.setParameter("to", toDate);
if (level != null) {
query.setParameter("level", level);
}
if (categories != null && !categories.isEmpty()) {
query.setParameter("categories", categories);
}
if (subCategories != null && !subCategories.isEmpty()) {
query.setParameter("subCategories", subCategories);
}
query.setMaxResults(perPage);
if (page > 1) {
query.setFirstResult(((page-1) * perPage) + 1);
}
return query.getResultList();
});
return new Pair<>(count.get(), events);
}
protected void store(SyslogEvent syslogEvent) {
if (persistenceService == null)
return;
// If we are not ready (on startup), ignore
if (persistenceService.getEntityManagerFactory() == null) {
return;
}
boolean isLoggable =
config.getStoredLevel().isLoggable(syslogEvent)
&& Arrays.asList(config.getStoredCategories()).contains(syslogEvent.getCategory());
if (isLoggable) {
synchronized (batch) {
batch.add(syslogEvent);
}
}
}
protected void flushBatch() {
if (persistenceService == null)
return;
synchronized (batch) {
final List transientEvents = new ArrayList<>(batch);
batch.clear();
if (transientEvents.size() == 0)
return;
LOG.finest("Flushing syslog batch: " + transientEvents.size());
try {
persistenceService.doTransaction(em -> {
try {
for (SyslogEvent e : transientEvents) {
em.persist(e);
}
} catch (RuntimeException ex) {
// This is not a big problem, it may happen on shutdown of database connections during tests, just inform the user
// TODO Or is it a serious problem and we need to escalate? In any case, just throwing the ex is not good
LOG.info("Error flushing syslog to database, some events are lost: " + ex);
} finally {
em.flush();
}
});
} catch (Exception e) {
LOG.log(Level.SEVERE, "Exception occurred whilst flushing the syslog", e);
}
}
}
@Override
public String toString() {
return getClass().getSimpleName() + "{}";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy