aboutsummaryrefslogtreecommitdiffstats
path: root/docs/requirements-docs.txt
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2022-04-11 15:55:45 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2022-04-11 15:55:45 +0200
commit667217c9a06ec40d2d71ab8f34515f4325631f48 (patch)
tree63e4f3f2ca19b3bf35a01540b1b75081ebead0d8 /docs/requirements-docs.txt
parent9dc0930e3c8f520b97b37c5bce7636288682ade8 (diff)
Add bounds to sphinx requirement
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I5ed268d592986764bf040690a47c5024692768b7
Diffstat (limited to 'docs/requirements-docs.txt')
-rw-r--r--docs/requirements-docs.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 5a3d2f17f4..3b3441a807 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1 +1,3 @@
-lfdocs-conf \ No newline at end of file
+lfdocs-conf
+sphinx>=4.2.0 # BSD
+sphinx-rtd-theme>=1.0.0 # MIT
f='#n134'>134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 
<!--
  ============LICENSE_START=======================================================
  policy-api
  ================================================================================
  Copyright (C) 2017-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=========================================================
  -->

<configuration scan="true" scanPeriod="30 seconds" debug="false">

    <property name="logDir" value="${POLICY_LOGS}" />

    <property name="errorLog" value="error" />
    <property name="debugLog" value="debug" />
    <property name="networkLog" value="network" />

    <property name="metricLog" value="metric" />
    <property name="transactionLog" value="audit" />

    <property name="debugPattern"
        value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%level|%logger{0}|%thread] %msg%n" />
    <property name="errorPattern" value="${debugPattern}" />
    <property name="networkPattern"
        value="[%d{yyyy-MM-dd'T'HH:mm:ss.SSS+00:00, UTC}|%t]%m%n" />

    <property name="metricPattern"
        value="%X{RequestID}|%X{InvocationID}|%X{ServiceName}|%X{PartnerName}|%X{BeginTimestamp}|%X{EndTimestamp}|%X{ElapsedTime}|%X{ServiceInstanceID}|%X{VirtualServerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%X{Severity}|%X{TargetEntity}|%X{TargetServiceName}|%X{Server}|%X{ServerIPAddress}|%X{ServerFQDN}|%X{ClientIPAddress}|%X{ProcessKey}|%X{RemoteHost}|%X{AlertSeverity}|%X{TargetVirtualEntity}|%level|%thread| %msg%n" />
    <property name="transactionPattern" value="${metricPattern}" />

    <appender name="ErrorOut"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/${errorLog}.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/${errorLog}.%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
        <encoder>
            <pattern>${errorPattern}</pattern>
        </encoder>
    </appender>

    <appender name="AsyncErrorOut"
        class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="ErrorOut" />
    </appender>

    <appender name="DebugOut"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/${debugLog}.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/${debugLog}.%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${debugPattern}</pattern>
        </encoder>
    </appender>

    <appender name="AsyncDebugOut"
        class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="DebugOut" />
    </appender>

    <appender name="NetworkOut"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/${networkLog}.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/${networkLog}.%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${networkPattern}</pattern>
        </encoder>
    </appender>

    <appender name="AsyncNetworkOut"
        class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="NetworkOut" />
    </appender>

    <appender name="MetricOut"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/${metricLog}.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/${metricLog}.%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${metricPattern}</pattern>
        </encoder>
    </appender>

    <appender name="AsyncMetricOut"
        class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="MetricOut" />
    </appender>

    <appender name="TransactionOut"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logDir}/${transactionLog}.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${logDir}/${transactionLog}.%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${transactionPattern}</pattern>
        </encoder>
    </appender>

    <appender name="AsyncTransactionOut"
        class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="TransactionOut" />
    </appender>

    <logger name="network" level="INFO" additivity="false">
        <appender-ref ref="AsyncNetworkOut" />
    </logger>

    <logger name="org.eclipse.jetty.server.RequestLog" level="info"
        additivity="false">
        <appender-ref ref="AsyncNetworkOut" />
    </logger>

    <root level="INFO">
        <appender-ref ref="AsyncDebugOut" />
        <appender-ref ref="AsyncErrorOut" />
        <appender-ref ref="AsyncMetricOut" />
        <appender-ref ref="AsyncTransactionOut" />
    </root>

</configuration>