From 62e4281c0b76ecfde85d094533edd6693c2c1c5b Mon Sep 17 00:00:00 2001 From: Daniel Cruz Date: Fri, 22 Feb 2019 11:31:17 -0600 Subject: Add Controller Logging Feature This features provides a mechanism to extend the logback.xml properties to add controller specific loggers. The controller's logger will log messages from topics that the controller listens to in a controller specific network log. The original network log is preserved and still logs every message from every controller. Note that the way a logger is associated with a controller is by having the logger name match the controller's name. Any configuration file that has "logback-include-" prepended and a ".xml" extension will be added to the logback.xml and logback-eelf.xml files as extensions to the base configuration. Issue-ID: POLICY-1427 Change-Id: Iaeb823421eadb7ee413b6b03ae3dfe862f230612 Signed-off-by: Daniel Cruz --- .../src/main/feature/install/disable | 26 ++++++ .../src/main/feature/install/enable | 29 +++++++ .../logging/ControllerLoggingFeature.java | 97 ++++++++++++++++++++++ ...licy.drools.features.DroolsControllerFeatureAPI | 1 + ...licy.drools.features.PolicyControllerFeatureAPI | 1 + ...p.policy.drools.features.PolicyEngineFeatureAPI | 1 + 6 files changed, 155 insertions(+) create mode 100644 feature-controller-logging/src/main/feature/install/disable create mode 100644 feature-controller-logging/src/main/feature/install/enable create mode 100755 feature-controller-logging/src/main/java/org/onap/policy/drools/controller/logging/ControllerLoggingFeature.java create mode 100755 feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.DroolsControllerFeatureAPI create mode 100755 feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI create mode 100755 feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyEngineFeatureAPI (limited to 'feature-controller-logging/src/main') diff --git a/feature-controller-logging/src/main/feature/install/disable b/feature-controller-logging/src/main/feature/install/disable new file mode 100644 index 00000000..698b6b3d --- /dev/null +++ b/feature-controller-logging/src/main/feature/install/disable @@ -0,0 +1,26 @@ +#!/bin/bash + +# ============LICENSE_START======================================================= +# feature-controller-logging +# ================================================================================ +# Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. +# ================================================================================ +# Licensed 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. +# ============LICENSE_END========================================================= + +configDir=${POLICY_HOME}/config +for mainConfig in ${configDir}/logback.xml ${configDir}/logback-eelf.xml; do + if [ -e "${mainConfig}" ]; then + sed -i --follow-symlinks "/\/d" "${mainConfig}" + fi +done \ No newline at end of file diff --git a/feature-controller-logging/src/main/feature/install/enable b/feature-controller-logging/src/main/feature/install/enable new file mode 100644 index 00000000..170598b3 --- /dev/null +++ b/feature-controller-logging/src/main/feature/install/enable @@ -0,0 +1,29 @@ +#!/bin/bash + +# ============LICENSE_START======================================================= +# feature-controller-logging +# ================================================================================ +# Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. +# ================================================================================ +# Licensed 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. +# ============LICENSE_END========================================================= + +configDir=${POLICY_HOME}/config +for includedConfig in $(ls "${configDir}" | grep "logback-include-.*.xml"); do + include="\t\" + for mainConfig in ${configDir}/logback.xml ${configDir}/logback-eelf.xml; do + if [ -e "${mainConfig}" ]; then + sed -i --follow-symlinks "/\ /a\ ${include}" "${mainConfig}" + fi + done +done \ No newline at end of file diff --git a/feature-controller-logging/src/main/java/org/onap/policy/drools/controller/logging/ControllerLoggingFeature.java b/feature-controller-logging/src/main/java/org/onap/policy/drools/controller/logging/ControllerLoggingFeature.java new file mode 100755 index 00000000..ec59ace6 --- /dev/null +++ b/feature-controller-logging/src/main/java/org/onap/policy/drools/controller/logging/ControllerLoggingFeature.java @@ -0,0 +1,97 @@ +/* + * ============LICENSE_START======================================================= + * feature-controller-logging + * ================================================================================ + * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.controller.logging; + +import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; +import org.onap.policy.common.endpoints.event.comm.TopicSink; +import org.onap.policy.drools.controller.DroolsController; +import org.onap.policy.drools.features.DroolsControllerFeatureAPI; +import org.onap.policy.drools.features.PolicyControllerFeatureAPI; +import org.onap.policy.drools.features.PolicyEngineFeatureAPI; +import org.onap.policy.drools.protocol.configuration.ControllerConfiguration; +import org.onap.policy.drools.protocol.configuration.PdpdConfiguration; +import org.onap.policy.drools.system.PolicyController; +import org.onap.policy.drools.system.PolicyEngine; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This class hooks the network logging implementation into DroolsPDP. It will disable the + * default network logger where all topic traffic is logged and segregates the topic + * traffic by controller for each supported control loop use case. + */ + +/* + * PolicyControllerFeatureAPI - the 'beforeStart' hook is used to shut off the default + * network logger and the 'beforeOffer' hook is used to log incoming topic messages + * + * DroolsControllerFeatureAPI - the 'afterDeliver' hook is where the outgoing topic + * messages are logged + * + */ +public class ControllerLoggingFeature + implements PolicyEngineFeatureAPI, DroolsControllerFeatureAPI, PolicyControllerFeatureAPI { + + @Override + public int getSequenceNumber() { + return 1000; + } + + /** + * The 'beforeOffer' hook will intercept an incoming topic message and append it to + * the log file that is configured for the controller logger. + */ + @Override + public boolean beforeOffer(PolicyController controller, CommInfrastructure protocol, String topic, String event) { + Logger controllerLogger = LoggerFactory.getLogger(controller.getName()); + controllerLogger.info("[IN|{}|{}]{}{}", protocol, topic, System.lineSeparator(), event); + return false; + } + + /** + * The 'afterDeliver' hook will intercept an outgoing topic message and append it to + * the log file that is configured for the controller logger. + */ + @Override + public boolean afterDeliver(DroolsController controller, TopicSink sink, Object fact, String json, + boolean success) { + if (success) { + Logger controllerLogger = LoggerFactory.getLogger(PolicyController.factory.get(controller).getName()); + controllerLogger.info("[OUT|{}|{}]{}{}", sink.getTopicCommInfrastructure(), sink.getTopic(), + System.lineSeparator(), json); + } + return false; + } + + /** + * The 'afterOnTopicEvent' hook will determine which controllers were updated and log + * the event to the appropriate controller logs. + */ + @Override + public boolean afterOnTopicEvent(PolicyEngine engine, PdpdConfiguration configuration, CommInfrastructure commType, + String topic, String event) { + for (ControllerConfiguration controller : configuration.getControllers()) { + Logger controllerLogger = LoggerFactory.getLogger(controller.getName()); + controllerLogger.info("[IN|{}|{}]{}{}", commType, topic, System.lineSeparator(), event); + } + return false; + } +} diff --git a/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.DroolsControllerFeatureAPI b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.DroolsControllerFeatureAPI new file mode 100755 index 00000000..dbde0a80 --- /dev/null +++ b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.DroolsControllerFeatureAPI @@ -0,0 +1 @@ +org.onap.policy.drools.controller.logging.ControllerLoggingFeature diff --git a/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI new file mode 100755 index 00000000..dbde0a80 --- /dev/null +++ b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyControllerFeatureAPI @@ -0,0 +1 @@ +org.onap.policy.drools.controller.logging.ControllerLoggingFeature diff --git a/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyEngineFeatureAPI b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyEngineFeatureAPI new file mode 100755 index 00000000..dbde0a80 --- /dev/null +++ b/feature-controller-logging/src/main/resources/META-INF/services/org.onap.policy.drools.features.PolicyEngineFeatureAPI @@ -0,0 +1 @@ +org.onap.policy.drools.controller.logging.ControllerLoggingFeature -- cgit 1.2.3-korg