From 0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 16 Oct 2020 13:09:11 +0100 Subject: Remove apex asciidoc documents Apex documentation has now all been ported to use the ONAP recommended rst format. This review removes the old asciidoc documents. Issue-ID: POLICY-2824 Change-Id: I562bd344cb7d6ff36e7d54bdb8f95e3b656468f8 Signed-off-by: liamfallon --- .../fragments/howto-logging/example-logic.adoc | 64 --------------- .../fragments/howto-logging/example-server.adoc | 46 ----------- .../adoc/fragments/howto-logging/introduction.adoc | 39 --------- .../fragments/howto-logging/logback-status.adoc | 31 -------- .../adoc/fragments/howto-logging/logging-3pps.adoc | 37 --------- .../howto-logging/logging-policy-logic.adoc | 47 ----------- .../howto-logging/rolling-file-appenders.adoc | 71 ----------------- .../howto-logging/standard-configuration.adoc | 93 ---------------------- 8 files changed, 428 deletions(-) delete mode 100644 src/site-docs/adoc/fragments/howto-logging/example-logic.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/example-server.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/introduction.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/logback-status.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc delete mode 100644 src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc (limited to 'src/site-docs/adoc/fragments/howto-logging') diff --git a/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc b/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc deleted file mode 100644 index 8f22cb498..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/example-logic.adoc +++ /dev/null @@ -1,64 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Example Configuration for Logging Logic - -The following example shows a configuration that logs policy logic to standard out and a file (__info__). -All other APEX components are logging to a file (__debug__).. -This configuration an be used in a pre-production phase with the APEX engine still running in a separate terminal to monitor policy execution. -This logback configuration is in the APEX installation as `etc/logback-logic.xml`. - -[source%nowrap,xml] ----- - - - - Apex - - - - - %d %contextName [%t] %level %logger{36} - %msg%n - - - - - ${VAR_LOG}/apex.log - - - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - - - - - - - policy: %msg\n - - - - - - - - - - - - - - - - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/example-server.adoc b/src/site-docs/adoc/fragments/howto-logging/example-server.adoc deleted file mode 100644 index 8f40a4217..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/example-server.adoc +++ /dev/null @@ -1,46 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Example Configuration for a Production Server - -The following example shows a configuration that logs all APEX components, including policy logic, to a file (__debug__). -This configuration an be used in a production phase with the APEX engine being executed as a service on a system without console output. -This logback configuration is in the APEX installation as `logback-server.xml` - -[source%nowrap,xml] ----- - - - - Apex - - - - ${VAR_LOG}/apex.log - - - %d %-5relative [procId=${processId}] [%thread] %-5level%logger{26} - %msg %n %ex{full} - - - - - - - - - - - - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/introduction.adoc b/src/site-docs/adoc/fragments/howto-logging/introduction.adoc deleted file mode 100644 index 0bc37c58d..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/introduction.adoc +++ /dev/null @@ -1,39 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Introduction to APEX Logging - -All APEX components make extensive use of logging using the logging façade link:https://www.slf4j.org/[SLF4J] with the backend link:https://logback.qos.ch/[Logback]. -Both are used off-the-shelve, so the standard documentation and configuration apply to APEX logging. -For details on how to work with logback please see the link:https://logback.qos.ch/manual/index.html[logback manual]. - -The APEX applications is the logback configuration file `$APEX_HOME/etc/logback.xml` (Windows: `%APEX_HOME%\etc\logback.xml`). -The logging backend is set to no debug, i.e. logs from the logging framework should be hidden at runtime. - -The configurable log levels work as expected: - -- __error__ (or __ERROR__) is used for serious errors in the APEX runtime engine -- __warn__ (or __WARN__) is used for warnings, which in general can be ignored but might indicate some deeper problems -- __info__ (or __INFO__) is used to provide generally interesting messages for startup and policy execution -- __debug__ (or __DEBUG__) provides more details on startup and policy execution -- __trace__ (or __TRACE__) gives full details on every aspect of the APEX engine from start to end - -The loggers can also be configured as expected. -The standard configuration (after installing APEX) uses log level __info__ on all APEX classes (components). - -The applications and scripts in `$APEX_HOME/bin` (Windows: `%APEX_HOME\bin`) are configured to use the logback configuration `$APEX_HOME/etc/logback.xml` (Windows: `%APEX_HOME\etc\logback.xml`). -There are multiple ways to use different logback configurations, for instance: - -- Maintain multiple configurations in `etc`, for instance a `logback-debug.xml` for deep debugging and a `logback-production.xml` for APEX in production mode, then copy the required configuration file to the used `logback.xml` prior starting APEX -- Edit the scripts in `bin` to use a different logback configuration file (only recommended if you are familiar with editing bash scripts or windows batch files) - diff --git a/src/site-docs/adoc/fragments/howto-logging/logback-status.adoc b/src/site-docs/adoc/fragments/howto-logging/logback-status.adoc deleted file mode 100644 index 985fa6dac..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/logback-status.adoc +++ /dev/null @@ -1,31 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Adding Logback Status and Debug - -To activate logback status messages change the status listener from 'NOP' to for instance console. - -[source%nowrap,xml] ----- - ----- - -To activate all logback debugging, for instance to debug a new logback configuration, activate the debug attribute in the configuration. - -[source%nowrap,xml] ----- - -... - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc b/src/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc deleted file mode 100644 index be2b9af38..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc +++ /dev/null @@ -1,37 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Logging External Components - -Logback can also be configured to log any other, external components APEX is using, if they are using the common logging framework. - -For instance, the context component of APEX is using __Infinispan__ and one can add a logger for this external component. -The following example adds a logger for __Infinispan__ using the standard output appender. - -[source%nowrap,xml] ----- - - - ----- - -Another example is Apache Zookeeper. -The following example adds a logger for Zookeeper using the standard outout appender. - -[source%nowrap,xml] ----- - - - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc b/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc deleted file mode 100644 index a0cc02591..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc +++ /dev/null @@ -1,47 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Configuring loggers for Policy Logic - -The logging for the logic inside a policy (task logic, task selection logic, state finalizer logic) can be configured separate from standard logging. -The logger for policy logic is `org.onap.policy.apex.executionlogging`. -The following example defines - -- a new appender for standard out using a very simple pattern (simply the actual message) -- a logger for policy logic to standard out using the new appender and the already described file appender. - -[source%nowrap,xml] ----- - - - policy: %msg\n - - - - - - - - ----- - -It is also possible to use specific logging for parts of policy logic. -The following example defines a logger for task logic. - -[source%nowrap,xml] ----- - - - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc b/src/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc deleted file mode 100644 index 68a6d1cba..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc +++ /dev/null @@ -1,71 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Rolling File Appenders - -Rolling file appenders are a good option for more complex logging of a production or complex testing APEX installation. -The standard logback configuration can be used for these use cases. -This section gives two examples for the standard logging and for context logging. - -First the standard logging. -The following example defines a rolling file appender. -The appender rolls over on a daily basis. -It allows for a file size of 100 MB. - -[source%nowrap,xml] ----- - - ${VAR_LOG}/apex.log - - - - ${VAR_LOG}/apex_%d{yyyy-MM-dd}.%i.log.gz - - 4 - - - 100MB - - - - - %d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %ex{full} %n - - - ----- - -A very similar configuration can be used for a rolling file appender logging APEX context. - -[source%nowrap,xml] ----- - - ${VAR_LOG}/apex_ctxt.log - - ${VAR_LOG}/apex_ctxt_%d{yyyy-MM-dd}.%i.log.gz - - 4 - - 100MB - - - - - %d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %ex{full} %n - - - ----- - diff --git a/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc b/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc deleted file mode 100644 index 4cd4b9b67..000000000 --- a/src/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc +++ /dev/null @@ -1,93 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Standard Logging Configuration - -The standard logging configuration defines a context __APEX__, which is used in the standard output pattern. -The location for log files is defined in the property `VAR_LOG` and set to `/var/log/onap/policy/apex-pdp`. -The standard status listener is set to __NOP__ and the overall logback configuration is set to no debug. - -[source%nowrap,xml,numbered] ----- - - - - Apex - - - ...appenders - ...loggers - ----- - -The first appender defined is called `STDOUT` for logs to standard out. - -[source%nowrap,xml,numbered] ----- - - - %d %contextName [%t] %level %logger{36} - %msg%n - - ----- - -The root level logger then is set to the level __info__ using the standard out appender. -[source%nowrap,xml,numbered] ----- - - - ----- - -The second appender is called `FILE`. -It writes logs to a file `apex.log`. -[source%nowrap,xml,numbered] ----- - - ${VAR_LOG}/apex.log - - %d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %n %ex{full} - - ----- - -The third appender is called `CTXT_FILE`. -It writes logs to a file `apex_ctxt.log`. -[source%nowrap,xml,numbered] ----- - - ${VAR_LOG}/apex_ctxt.log - - %d %-5relative [procId=${processId}] [%thread] %-5level %logger{26} - %msg %n %ex{full} - - ----- - -The last definitions are for specific loggers. -The first logger captures all standard APEX classes. -It is configured for log level __info__ and uses the standard output and file appenders. -The second logger captures APEX context classes responsible for context monitoring. -It is configured for log level __trace__ and uses the context file appender. - -[source%nowrap,xml,numbered] ----- - - - - - - - - ----- - -- cgit 1.2.3-korg