summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
blob: d211470a62c763aa4f298e0ac42fa6675da422d9 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

from docs_conf.conf import *

branch = 'latest'
master_doc = 'index'

linkcheck_ignore = [
    'http://localhost',
]

intersphinx_mapping = {}

html_last_updated_fmt = '%d-%b-%y %H:%M'

def setup(app):
    app.add_css_file("css/ribbon.css")
ng.Heredoc */ .highlight .si { color: #e6db74 } /* Literal.String.Interpol */ .highlight .sx { color: #e6db74 } /* Literal.String.Other */ .highlight .sr { color: #e6db74 } /* Literal.String.Regex */ .highlight .s1 { color: #e6db74 } /* Literal.String.Single */ .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ } @media (prefers-color-scheme: light) { .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ } 
<configuration scan="true" scanPeriod="10 seconds" debug="false">
		<jmxConfigurator />
		<property name="logDirectory" value="log" />
		<!-- Example evaluator filter applied against console appender -->
		<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
				<!-- filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>ERROR</level> 
						<onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter -->
				<!-- deny all events with a level below INFO, that is TRACE and DEBUG -->
				<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
						<level>INFO</level>
				</filter>
				<encoder>
						<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{1024} - %msg%n
						</pattern>
				</encoder>
		</appender>

		<appender name="ERROR"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
						<level>INFO</level>
				</filter>
				<file>${logDirectory}/CLAMP/error.log</file>
				<append>true</append>
				<encoder>
						<pattern>%date{"yyyy-MM-dd'T'HH:mm:ss,SSSXXX", UTC}|%X{RequestId}|%.20thread|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%.-5level|%X{ErrorCode}|%X{ErrorDescription}|%msg%n</pattern>
				</encoder>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<maxIndex>10</maxIndex>
						<FileNamePattern>${logDirectory}/CLAMP/error.%i.log.zip
						</FileNamePattern>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>10MB</maxFileSize>
				</triggeringPolicy>
		</appender>

		<appender name="DEBUG"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<file>${logDirectory}/CLAMP/debug.log</file>
				<append>true</append>
				<encoder>
						<pattern>%date{"yyyy-MM-dd'T'HH:mm:ss,SSSXXX",UTC}|%X{RequestId}|%.20thread|%.-5level|%logger{36}|%msg%n</pattern>
				</encoder>
				<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
					<fileNamePattern>${logDirectory}/CLAMP/debug.%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
					<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
						<maxFileSize>10MB</maxFileSize>
					</timeBasedFileNamingAndTriggeringPolicy>
					<maxHistory>5</maxHistory>
				</rollingPolicy>
		</appender>

		<appender name="AUDIT"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<file>${logDirectory}/CLAMP/audit.log</file>
				<append>true</append>
				<encoder>
						<pattern>%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestId}|%X{ServiceInstanceId}|%.20thread|%X{VirtualServerName}|%X{ServiceName}|%X{PartnerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}|%X{Unused}|%X{ProcessKey}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n
						</pattern>
				</encoder>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<maxIndex>10</maxIndex>
						<FileNamePattern>${logDirectory}/CLAMP/audit.%i.log.zip
						</FileNamePattern>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>10MB</maxFileSize>
				</triggeringPolicy>
		</appender>
		<appender name="asyncEELFAudit" class="ch.qos.logback.classic.AsyncAppender">
				<queueSize>256</queueSize>
				<appender-ref ref="AUDIT" />
		</appender>

		<appender name="METRIC"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<file>${logDirectory}/CLAMP/metric.log</file>
				<append>true</append>
				<encoder>
						<pattern>%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestId}|%X{ServiceInstanceId}|%.20thread|%X{VirtualServerName}|%X{ServiceName}|%X{PartnerName}|%X{TargetEntity}|%X{TargetServiceName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}|%X{Unused}|%X{ProcessKey}|%X{TargetVirtualEntity}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|
								%msg%n</pattern>
				</encoder>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<maxIndex>10</maxIndex>
						<FileNamePattern>${logDirectory}/CLAMP/metric.%i.log.zip
						</FileNamePattern>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>10MB</maxFileSize>
				</triggeringPolicy>
		</appender>
		<appender name="asyncEELFMetrics" class="ch.qos.logback.classic.AsyncAppender">
				<queueSize>256</queueSize>
				<appender-ref ref="METRIC" />
		</appender>

		<!-- SECURITY related loggers -->
		<appender name="SECURITY"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<file>${logDirectory}/CLAMP/security.log</file>
				<append>true</append>
				<encoder>
						<pattern>%X{BeginTimestamp}|%X{EndTimestamp}|%X{RequestId}|%X{ServiceInstanceId}|%.20thread|%X{VirtualServerName}|%X{ServiceName}|%X{PartnerName}|%X{StatusCode}|%X{ResponseCode}|%X{ResponseDescription}|%X{InstanceUUID}|%.-5level|%X{AlertSeverity}|%X{ServerIPAddress}|%X{ElapsedTime}|%X{ServerFQDN}|%X{RemoteHost}|%X{ClassName}|%X{Unused}|%X{ProcessKey}|%X{CustomField1}|%X{CustomField2}|%X{CustomField3}|%X{CustomField4}|%msg%n
						</pattern>
				</encoder>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<maxIndex>10</maxIndex>
						<FileNamePattern>${logDirectory}/CLAMP/security.%i.log.zip
						</FileNamePattern>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>10MB</maxFileSize>
				</triggeringPolicy>
		</appender>
		<appender name="asyncEELFSecurity" class="ch.qos.logback.classic.AsyncAppender">
				<queueSize>256</queueSize>
				<appender-ref ref="SECURITY" />
		</appender>

		<!-- CLDS related loggers -->
		<logger name="org.onap.clamp.clds" level="INFO" additivity="true">
				<appender-ref ref="ERROR" />
		</logger>
		
		<!-- CLDS related loggers -->
		<logger name="com.att.eelf.error" level="OFF" additivity="true">
				<appender-ref ref="ERROR" />
		</logger>
		<!-- EELF related loggers -->
		<logger name="com.att.eelf.audit" level="INFO" additivity="false">
				<appender-ref ref="asyncEELFAudit" />
		</logger>
		<logger name="com.att.eelf.metrics" level="DEBUG" additivity="false">
				<appender-ref ref="asyncEELFMetrics" />
		</logger>
		<logger name="com.att.eelf.security" level="DEBUG" additivity="false">
				<appender-ref ref="asyncEELFSecurity" />
		</logger>


		<!-- Spring related loggers -->
		<logger name="org.springframework" level="WARN" />
		<logger name="org.springframework.beans" level="WARN" />
		<logger name="org.springframework.web" level="WARN" />
		<logger name="com.blog.spring.jms" level="WARN" />

		<!-- Other Loggers that may help troubleshoot -->
		<logger name="net.sf" level="WARN" />
		<logger name="org.apache.commons.httpclient" level="WARN" />
		<logger name="org.apache.commons" level="WARN" />
		<logger name="org.apache.coyote" level="WARN" />
		<logger name="org.apache.jasper" level="WARN" />

		<!-- Camel Related Loggers (including restlet/servlet/jaxrs/cxf logging. 
				May aid in troubleshooting) -->
		<logger name="org.apache.camel" level="WARN" />
		<logger name="org.apache.cxf" level="WARN" />
		<logger name="org.apache.camel.processor.interceptor" level="WARN" />
		<logger name="org.apache.cxf.jaxrs.interceptor" level="WARN" />
		<logger name="org.apache.cxf.service" level="WARN" />
		<logger name="org.restlet" level="DEBUG" />
		<logger name="org.apache.camel.component.restlet" level="DEBUG" />

		<!-- logback internals logging -->
		<logger name="ch.qos.logback.classic" level="INFO" />
		<logger name="ch.qos.logback.core" level="INFO" />

		<!-- logback jms appenders & loggers definition starts here -->
		<!-- logback jms appenders & loggers definition starts here -->
		<appender name="auditLogs"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
				</filter>
				<file>${logDirectory}/Audit-${lrmRVer}-${lrmRO}-${Pid}.log</file>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<fileNamePattern>${logDirectory}/Audit-${lrmRVer}-${lrmRO}-${Pid}.%i.log.zip
						</fileNamePattern>
						<minIndex>1</minIndex>
						<maxIndex>9</maxIndex>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>5MB</maxFileSize>
				</triggeringPolicy>
				<encoder>
						<pattern>"%d [%thread] %-5level %logger{1024} - %msg%n"</pattern>
				</encoder>
		</appender>
		<appender name="perfLogs"
				class="ch.qos.logback.core.rolling.RollingFileAppender">
				<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
				</filter>
				<file>${logDirectory}/Perform-${lrmRVer}-${lrmRO}-${Pid}.log</file>
				<rollingPolicy
						class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
						<fileNamePattern>${logDirectory}/Perform-${lrmRVer}-${lrmRO}-${Pid}.%i.log.zip
						</fileNamePattern>
						<minIndex>1</minIndex>
						<maxIndex>9</maxIndex>
				</rollingPolicy>
				<triggeringPolicy
						class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
						<maxFileSize>5MB</maxFileSize>
				</triggeringPolicy>
				<encoder>
						<pattern>"%d [%thread] %-5level %logger{1024} - %msg%n"</pattern>
				</encoder>
		</appender>
		<logger name="AuditRecord" level="INFO" additivity="FALSE">
				<appender-ref ref="auditLogs" />
		</logger>
		<logger name="AuditRecord_DirectCall" level="INFO" additivity="FALSE">
				<appender-ref ref="auditLogs" />
		</logger>
		<logger name="PerfTrackerRecord" level="INFO" additivity="FALSE">
				<appender-ref ref="perfLogs" />
		</logger>
		<!-- logback jms appenders & loggers definition ends here -->

		<root level="WARN">
				<appender-ref ref="DEBUG" />
				<appender-ref ref="STDOUT" />
		</root>

</configuration>