WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Logback Logging

CAS does also support Logback as an alternative logging engine. At a high level, the Logback architecture is similar to that of Log4j where you have Logger, Appender and Layout components typically defined inside a logback.xml file.

Refer to the Logback documentation to learn more.

Configuration

Support is enabled by including the following dependency in the WAR overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-logback</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-logback:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-logback"
}

dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-logback"
}

You must also make sure the following modules and dependencies are excluded from the WAR overlay:

configurations.all {
    exclude(group: "org.apache.logging.log4j", module: "log4j-api")
    exclude(group: "org.apache.logging.log4j", module: "log4j-jakarta-web")
    exclude(group: "org.apache.logging.log4j", module: "log4j-web")
    exclude(group: "org.apache.logging.log4j", module: "log4j-jcl")
    exclude(group: "org.apache.logging.log4j", module: "log4j-slf4j-impl")
    exclude(group: "org.apache.logging.log4j", module: "log4j-slf4j2-impl")
    
    exclude(group: "org.apereo.cas", module: "cas-server-core-logging")
}

A sample logback.xml file follows:

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds">
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%white(%d{yyyy-MM-dd HH:mm:ss}) %highlight(%-5level) %cyan(%logger{15}) - %msg%n</Pattern>
        </layout>
    </appender>
    <logger name="org.apereo.cas" level="info" additivity="false">
        <appender-ref ref="console" />
    </logger>
    <root level="info">
        <appender-ref ref="console" />
    </root>
</configuration>

Be Careful

Sanitizing log data to remove sensitive ticket ids such as ticket-granting tickets or proxy-granting tickets is not handled by CAS when Logback is used. While this may be worked out in future releases, you should be extra careful to cleanse log data prior to sharing it with external systems such as Splunk or Syslog, etc.

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

logging.charset.console=

Charset to use for console output.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.charset.console=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

logging: 
  charset: 
    console: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.charset.console="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_CHARSET_CONSOLE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.charset.console="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.charset.file=

Charset to use for file output.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.charset.file=...

CAS properties can be specified using the YAML syntax:

logging: 
  charset: 
    file: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.charset.file="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_CHARSET_FILE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.charset.file="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.config=

Location of the logging configuration file. For instance, `classpath:logback.xml` for Logback.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.config=...

CAS properties can be specified using the YAML syntax:

logging: 
  config: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.config="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_CONFIG="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.config="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.console.enabled=

Whether to enable console-based logging.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.console.enabled=...

CAS properties can be specified using the YAML syntax:

logging: 
  console: 
    enabled: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.console.enabled="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_CONSOLE_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.console.enabled="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.exception-conversion-word=%wEx

Conversion word used when logging exceptions.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.exception-conversion-word=%wEx

CAS properties can be specified using the YAML syntax:

logging: 
  exception-conversion-word: "%wEx"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.exception-conversion-word="%wEx" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_EXCEPTION_CONVERSION_WORD="%wEx"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.exception-conversion-word="%wEx"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.file=

Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file=...

CAS properties can be specified using the YAML syntax:

logging: 
  file: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: logging.file.name.

logging.file.clean-history-on-start=false

Whether to clean the archive log files on startup. Only supported with the default logback setup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.clean-history-on-start=...

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    clean-history-on-start: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.clean-history-on-start="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_CLEAN_HISTORY_ON_START="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.clean-history-on-start="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: logging.logback.rollingpolicy.clean-history-on-start.

logging.file.max-history=7

Maximum number of archive log files to keep. Only supported with the default logback setup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.max-history=7

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    max-history: "7"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.max-history="7" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_MAX_HISTORY="7"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.max-history="7"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: logging.logback.rollingpolicy.max-history.

logging.file.max-size=10MB

Maximum log file size. Only supported with the default logback setup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.max-size=10MB

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    max-size: "10MB"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.max-size="10MB" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_MAX_SIZE="10MB"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.max-size="10MB"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: logging.logback.rollingpolicy.max-file-size.

logging.file.name=

Log file name (for instance, `myapp.log`). Names can be an exact location or relative to the current directory.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.name=...

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.file.path=

Location of the log file. For instance, `/var/log`.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.path=...

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.file.total-size-cap=0B

Total size of log backups to be kept. Only supported with the default logback setup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.file.total-size-cap=0B

CAS properties can be specified using the YAML syntax:

logging: 
  file: 
    total-size-cap: "0B"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.file.total-size-cap="0B" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_FILE_TOTAL_SIZE_CAP="0B"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.file.total-size-cap="0B"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: logging.logback.rollingpolicy.total-size-cap.

logging.group=

Log groups to quickly change multiple loggers at the same time. For instance, `logging.group.db=org.hibernate,org.springframework.jdbc`.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.group=...

CAS properties can be specified using the YAML syntax:

logging: 
  group: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.group="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_GROUP="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.group="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.include-application-group=true

Whether to include the application group in the logs.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.include-application-group=true

CAS properties can be specified using the YAML syntax:

logging: 
  include-application-group: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.include-application-group="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_INCLUDE_APPLICATION_GROUP="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.include-application-group="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.include-application-name=true

Whether to include the application name in the logs.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.include-application-name=true

CAS properties can be specified using the YAML syntax:

logging: 
  include-application-name: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.include-application-name="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_INCLUDE_APPLICATION_NAME="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.include-application-name="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.level=

Log levels severity mapping. For instance, `logging.level.org.springframework=DEBUG`.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.level=...

CAS properties can be specified using the YAML syntax:

logging: 
  level: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.level="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LEVEL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.level="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.log4j2.config.override=

Overriding configuration files used to create a composite configuration. Can be prefixed with 'optional:' to only load the override if it exists.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.log4j2.config.override=...

CAS properties can be specified using the YAML syntax:

logging: 
  log4j2: 
    config: 
      override: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.log4j2.config.override="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOG4J2_CONFIG_OVERRIDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.log4j2.config.override="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.logback.rollingpolicy.clean-history-on-start=false

Whether to clean the archive log files on startup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.logback.rollingpolicy.clean-history-on-start=...

CAS properties can be specified using the YAML syntax:

logging: 
  logback: 
    rollingpolicy: 
      clean-history-on-start: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.logback.rollingpolicy.clean-history-on-start="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.logback.rollingpolicy.clean-history-on-start="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

Pattern for rolled-over log file names.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

CAS properties can be specified using the YAML syntax:

logging: 
  logback: 
    rollingpolicy: 
      file-name-pattern: "${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.logback.rollingpolicy.file-name-pattern="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.logback.rollingpolicy.file-name-pattern="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.logback.rollingpolicy.max-file-size=10MB

Maximum log file size.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.logback.rollingpolicy.max-file-size=10MB

CAS properties can be specified using the YAML syntax:

logging: 
  logback: 
    rollingpolicy: 
      max-file-size: "10MB"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.logback.rollingpolicy.max-file-size="10MB" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE="10MB"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.logback.rollingpolicy.max-file-size="10MB"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.logback.rollingpolicy.max-history=7

Maximum number of archive log files to keep.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.logback.rollingpolicy.max-history=7

CAS properties can be specified using the YAML syntax:

logging: 
  logback: 
    rollingpolicy: 
      max-history: "7"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.logback.rollingpolicy.max-history="7" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOGBACK_ROLLINGPOLICY_MAX_HISTORY="7"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.logback.rollingpolicy.max-history="7"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.logback.rollingpolicy.total-size-cap=0B

Total size of log backups to be kept.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.logback.rollingpolicy.total-size-cap=0B

CAS properties can be specified using the YAML syntax:

logging: 
  logback: 
    rollingpolicy: 
      total-size-cap: "0B"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.logback.rollingpolicy.total-size-cap="0B" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP="0B"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.logback.rollingpolicy.total-size-cap="0B"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.path=

Location of the log file. For instance, `/var/log`.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.path=...

CAS properties can be specified using the YAML syntax:

logging: 
  path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is ERRORwith a replacement setting: logging.file.path.

logging.pattern.console=

Appender pattern for output to the console. Its default value varies according to the logging system.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.console=...

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    console: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.console="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_CONSOLE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.console="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.pattern.correlation=

Appender pattern for log correlation. Its default value varies according to the logging system.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.correlation=...

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    correlation: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.correlation="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_CORRELATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.correlation="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.pattern.dateformat=yyyy-MM-dd'T'HH:mm:ss.SSSXXX

Appender pattern for log date format.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.dateformat=yyyy-MM-dd'T'HH:mm:ss.SSSXXX

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    dateformat: "yyyy-MM-dd'T'HH:mm:ss.SSSXXX"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.dateformat="yyyy-MM-dd'T'HH:mm:ss.SSSXXX" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_DATEFORMAT="yyyy-MM-dd'T'HH:mm:ss.SSSXXX"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.dateformat="yyyy-MM-dd'T'HH:mm:ss.SSSXXX"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.pattern.file=

Appender pattern for output to a file. Its default value varies according to the logging system.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.file=...

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    file: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.file="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_FILE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.file="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.pattern.level=%5p

Appender pattern for log level.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.level=%5p

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    level: "%5p"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.level="%5p" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_LEVEL="%5p"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.level="%5p"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.pattern.rolling-file-name=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

Pattern for rolled-over log file names. Supported only with the default Logback setup.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.pattern.rolling-file-name=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

CAS properties can be specified using the YAML syntax:

logging: 
  pattern: 
    rolling-file-name: "${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.pattern.rolling-file-name="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_PATTERN_ROLLING_FILE_NAME="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.pattern.rolling-file-name="${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

Deprecation status is WARNINGwith a replacement setting: logging.logback.rollingpolicy.file-name-pattern.

logging.register-shutdown-hook=true

Register a shutdown hook for the logging system when it is initialized. Disabled automatically when deployed as a war file.

org.springframework.boot.context.logging.LoggingApplicationListener.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.register-shutdown-hook=true

CAS properties can be specified using the YAML syntax:

logging: 
  register-shutdown-hook: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.register-shutdown-hook="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_REGISTER_SHUTDOWN_HOOK="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.register-shutdown-hook="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.ecs.service.environment=

Structured ECS service environment.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.ecs.service.environment=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    ecs: 
      service: 
        environment: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.ecs.service.environment="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_ECS_SERVICE_ENVIRONMENT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.ecs.service.environment="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.ecs.service.name=

Structured ECS service name (defaults to 'spring.application.name').

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.ecs.service.name=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    ecs: 
      service: 
        name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.ecs.service.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_ECS_SERVICE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.ecs.service.name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.ecs.service.node-name=

Structured ECS service node name.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.ecs.service.node-name=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    ecs: 
      service: 
        node-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.ecs.service.node-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_ECS_SERVICE_NODE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.ecs.service.node-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.ecs.service.version=

Structured ECS service version (defaults to 'spring.application.version').

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.ecs.service.version=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    ecs: 
      service: 
        version: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.ecs.service.version="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_ECS_SERVICE_VERSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.ecs.service.version="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.format.console=

Structured logging format for output to the console. Must be either a format id or a fully qualified class name.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.format.console=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    format: 
      console: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.format.console="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_FORMAT_CONSOLE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.format.console="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.format.file=

Structured logging format for output to a file. Must be either a format id or a fully qualified class name.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.format.file=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    format: 
      file: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.format.file="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_FORMAT_FILE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.format.file="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.gelf.host=

Structured GELF host (defaults to 'spring.application.name').

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.gelf.host=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    gelf: 
      host: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.gelf.host="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_GELF_HOST="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.gelf.host="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.gelf.service.version=

Structured GELF service version (defaults to 'spring.application.version').

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.gelf.service.version=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    gelf: 
      service: 
        version: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.gelf.service.version="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_GELF_SERVICE_VERSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.gelf.service.version="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.add=

Additional members that should be added to structured logging JSON

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.add=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      add: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.add="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_ADD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.add="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.context.include=

Whether context data should be included in the JSON.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.context.include=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      context: 
        include: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.context.include="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_CONTEXT_INCLUDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.context.include="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.context.prefix=

The prefix to use when inserting context data.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.context.prefix=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      context: 
        prefix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.context.prefix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_CONTEXT_PREFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.context.prefix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.customizer=

Fully qualified class names of StructuredLoggingJsonMembersCustomizer implementations

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.customizer=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      customizer: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.customizer="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_CUSTOMIZER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.customizer="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.exclude=

Member paths that should be excluded from structured logging JSON

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.exclude=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      exclude: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.exclude="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_EXCLUDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.exclude="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.include=

Member paths that should be included in structured logging JSON

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.include=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      include: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.include="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_INCLUDE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.include="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.rename=

Mapping between member paths and an alternative name that should be used in structured logging JSON

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.rename=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      rename: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.rename="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_RENAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.rename="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.include-common-frames=

Whether common frames should be included.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.include-common-frames=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        include-common-frames: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.include-common-frames="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_INCLUDE_COMMON_FRAMES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.include-common-frames="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.include-hashes=

Whether stack trace hashes should be included.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.include-hashes=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        include-hashes: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.include-hashes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_INCLUDE_HASHES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.include-hashes="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.max-length=

Maximum length to print.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.max-length=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        max-length: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.max-length="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_MAX_LENGTH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.max-length="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.max-throwable-depth=

Maximum throwable depth to print.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.max-throwable-depth=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        max-throwable-depth: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.max-throwable-depth="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_MAX_THROWABLE_DEPTH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.max-throwable-depth="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.printer=

Name of the printer to use. Can be 'standard', 'logging-system', or the fully-qualified class name of a StackTracePrinter. When not specified 'logging-system' or 'standard' will be used depending if other properties are set.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.printer=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        printer: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.printer="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_PRINTER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.printer="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.structured.json.stacktrace.root=

Root ordering (root first or root last).

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.structured.json.stacktrace.root=...

CAS properties can be specified using the YAML syntax:

logging: 
  structured: 
    json: 
      stacktrace: 
        root: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.structured.json.stacktrace.root="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_STRUCTURED_JSON_STACKTRACE_ROOT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.structured.json.stacktrace.root="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.threshold.console=TRACE

Log level threshold for console output.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.threshold.console=TRACE

CAS properties can be specified using the YAML syntax:

logging: 
  threshold: 
    console: "TRACE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.threshold.console="TRACE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_THRESHOLD_CONSOLE="TRACE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.threshold.console="TRACE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

logging.threshold.file=TRACE

Log level threshold for file output.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

logging.threshold.file=TRACE

CAS properties can be specified using the YAML syntax:

logging: 
  threshold: 
    file: "TRACE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dlogging.threshold.file="TRACE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export LOGGING_THRESHOLD_FILE="TRACE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --logging.threshold.file="TRACE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# Charset to use for console output.
# logging.charset.console=

# Charset to use for file output.
# logging.charset.file=

# Location of the logging configuration file.
# logging.config=

# Whether to enable console-based logging.
# logging.console.enabled=

# Conversion word used when logging exceptions.
# logging.exception-conversion-word=%wEx

# Log file name (for instance, `myapp.log`).
# logging.file=

# Whether to clean the archive log files on startup.
# logging.file.clean-history-on-start=false

# Maximum number of archive log files to keep.
# logging.file.max-history=7

# Maximum log file size.
# logging.file.max-size=10MB

# Log file name (for instance, `myapp.log`).
# logging.file.name=

# Location of the log file.
# logging.file.path=

# Total size of log backups to be kept.
# logging.file.total-size-cap=0B

# Log groups to quickly change multiple loggers at the same time.
# logging.group=

# Whether to include the application group in the logs.
# logging.include-application-group=true

# Whether to include the application name in the logs.
# logging.include-application-name=true

# Log levels severity mapping.
# logging.level=

# Overriding configuration files used to create a composite configuration.
# logging.log4j2.config.override=

# Whether to clean the archive log files on startup.
# logging.logback.rollingpolicy.clean-history-on-start=false

# Pattern for rolled-over log file names.
# logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

# Maximum log file size.
# logging.logback.rollingpolicy.max-file-size=10MB

# Maximum number of archive log files to keep.
# logging.logback.rollingpolicy.max-history=7

# Total size of log backups to be kept.
# logging.logback.rollingpolicy.total-size-cap=0B

# Location of the log file.
# logging.path=

# Appender pattern for output to the console.
# logging.pattern.console=

# Appender pattern for log correlation.
# logging.pattern.correlation=

# Appender pattern for log date format.
# logging.pattern.dateformat=yyyy-MM-dd'T'HH:mm:ss.SSSXXX

# Appender pattern for output to a file.
# logging.pattern.file=

# Appender pattern for log level.
# logging.pattern.level=%5p

# Pattern for rolled-over log file names.
# logging.pattern.rolling-file-name=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

# Register a shutdown hook for the logging system when it is initialized.
# logging.register-shutdown-hook=true

# Structured ECS service environment.
# logging.structured.ecs.service.environment=

# Structured ECS service name (defaults to 'spring.application.name').
# logging.structured.ecs.service.name=

# Structured ECS service node name.
# logging.structured.ecs.service.node-name=

# Structured ECS service version (defaults to 'spring.application.version').
# logging.structured.ecs.service.version=

# Structured logging format for output to the console.
# logging.structured.format.console=

# Structured logging format for output to a file.
# logging.structured.format.file=

# Structured GELF host (defaults to 'spring.application.name').
# logging.structured.gelf.host=

# Structured GELF service version (defaults to 'spring.application.version').
# logging.structured.gelf.service.version=

# Additional members that should be added to structured logging JSON
# logging.structured.json.add=

# Whether context data should be included in the JSON.
# logging.structured.json.context.include=

# The prefix to use when inserting context data.
# logging.structured.json.context.prefix=

# Fully qualified class names of StructuredLoggingJsonMembersCustomizer implementations
# logging.structured.json.customizer=

# Member paths that should be excluded from structured logging JSON
# logging.structured.json.exclude=

# Member paths that should be included in structured logging JSON
# logging.structured.json.include=

# Mapping between member paths and an alternative name that should be used in structured logging JSON
# logging.structured.json.rename=

# Whether common frames should be included.
# logging.structured.json.stacktrace.include-common-frames=

# Whether stack trace hashes should be included.
# logging.structured.json.stacktrace.include-hashes=

# Maximum length to print.
# logging.structured.json.stacktrace.max-length=

# Maximum throwable depth to print.
# logging.structured.json.stacktrace.max-throwable-depth=

# Name of the printer to use.
# logging.structured.json.stacktrace.printer=

# Root ordering (root first or root last).
# logging.structured.json.stacktrace.root=

# Log level threshold for console output.
# logging.threshold.console=TRACE

# Log level threshold for file output.
# logging.threshold.file=TRACE

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.