MonitoringImpl.java

/*******************************************************************************
 * Copyright (c) 2019 Eclipse RDF4J contributors.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Distribution License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *******************************************************************************/
package org.eclipse.rdf4j.federated.monitoring;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import org.eclipse.rdf4j.federated.FedXConfig;
import org.eclipse.rdf4j.federated.endpoint.Endpoint;
import org.eclipse.rdf4j.federated.exception.FedXRuntimeException;
import org.eclipse.rdf4j.federated.structures.QueryInfo;
import org.eclipse.rdf4j.query.algebra.TupleExpr;

/**
 * Implementation supporting the following monitoring features:
 *
 * - monitor remote requests per endpoint - maintain a query backlog using {@link QueryLog}
 *
 *
 * @author andreas_s
 *
 */
public class MonitoringImpl implements MonitoringService {

	/**
	 * Map endpoints to their request information
	 */
	private final Map<Endpoint, MonitoringInformation> requestMap = new ConcurrentHashMap<>();
	private final QueryLog queryLog;
	private final FedXConfig config;

	MonitoringImpl(FedXConfig config) {

		this.config = config;
		if (config.isLogQueries()) {
			try {
				queryLog = new QueryLog();
			} catch (IOException e) {
				throw new FedXRuntimeException("QueryLog cannot be initialized: " + e.getMessage());
			}
		} else {
			queryLog = null;
		}
	}

	@Override
	public void monitorRemoteRequest(Endpoint e) {
		MonitoringInformation m = requestMap.get(e);
		if (m == null) {
			m = new MonitoringInformation(e);
			requestMap.put(e, m);
		}
		m.increaseRequests();
	}

	@Override
	public MonitoringInformation getMonitoringInformation(Endpoint e) {
		return requestMap.get(e);
	}

	@Override
	public List<MonitoringInformation> getAllMonitoringInformation() {
		return new ArrayList<>(requestMap.values());
	}

	@Override
	public void resetMonitoringInformation() {
		requestMap.clear();
	}

	public static class MonitoringInformation {
		private final Endpoint e;
		private int numberOfRequests = 0;

		public MonitoringInformation(Endpoint e) {
			this.e = e;
		}

		private void increaseRequests() {
			// TODO make thread safe
			numberOfRequests++;
		}

		@Override
		public String toString() {
			return e.getName() + " => " + numberOfRequests;
		}

		public Endpoint getE() {
			return e;
		}

		public int getNumberOfRequests() {
			return numberOfRequests;
		}
	}

	@Override
	public void monitorQuery(QueryInfo query) {
		if (queryLog != null) {
			queryLog.logQuery(query);
		}
	}

	@Override
	public void logQueryPlan(TupleExpr tupleExpr) {
		if (config.isLogQueryPlan()) {
			QueryPlanLog.setQueryPlan(tupleExpr);
		}
	}
}