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>


1

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.}

Show entries

Search:

cas.logging.cloudwatch.credential-access-key=

Use access-key provided by AWS to authenticate.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.credential-access-key=...

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:

cas: 
  logging: 
    cloudwatch: 
      credential-access-key: "..."

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 -Dcas.logging.cloudwatch.credential-access-key="..." -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 CAS_LOGGING_CLOUDWATCH_CREDENTIAL_ACCESS_KEY="..."

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 --cas.logging.cloudwatch.credential-access-key="..."

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.logging.cloudwatch.credential-secret-key=

Use secret key provided by AWS to authenticate.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.credential-secret-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      credential-secret-key: "..."

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 -Dcas.logging.cloudwatch.credential-secret-key="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_CREDENTIAL_SECRET_KEY="..."

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 --cas.logging.cloudwatch.credential-secret-key="..."

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.logging.cloudwatch.endpoint=

AWS custom endpoint.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.endpoint=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      endpoint: "..."

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 -Dcas.logging.cloudwatch.endpoint="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_ENDPOINT="..."

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 --cas.logging.cloudwatch.endpoint="..."

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.logging.cloudwatch.log-group-name=

A log group is a container that organizes and stores log streams that share the same retention, monitoring, and access control settings. Each log group can have a unique name, and you can think of it as a logical grouping of logs that relate to a specific application, service, or environment.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.log-group-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      log-group-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 -Dcas.logging.cloudwatch.log-group-name="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_LOG_GROUP_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 --cas.logging.cloudwatch.log-group-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.

cas.logging.cloudwatch.log-stream-name=

A log stream is a sequence of log events that share the same source. Each log stream belongs to a log group, and you can have multiple log streams within a single log group. Log streams are typically used to separate log data from different sources within the same application or service.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.log-stream-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      log-stream-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 -Dcas.logging.cloudwatch.log-stream-name="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_LOG_STREAM_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 --cas.logging.cloudwatch.log-stream-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.

Showing 1 to 5 of 8 entries

Previous1 2Next

_{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.}

Show entries

Search:

cas.logging.cloudwatch.client-execution-timeout=10000

Client execution timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.client-execution-timeout=10000

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      client-execution-timeout: "10000"

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 -Dcas.logging.cloudwatch.client-execution-timeout="10000" -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_CLIENT_EXECUTION_TIMEOUT="10000"

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 --cas.logging.cloudwatch.client-execution-timeout="10000"

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.logging.cloudwatch.connection-timeout=5000

Connection timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.connection-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      connection-timeout: "5000"

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 -Dcas.logging.cloudwatch.connection-timeout="5000" -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_CONNECTION_TIMEOUT="5000"

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 --cas.logging.cloudwatch.connection-timeout="5000"

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.logging.cloudwatch.local-address=

Local address.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.local-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      local-address: "..."

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 -Dcas.logging.cloudwatch.local-address="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_LOCAL_ADDRESS="..."

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 --cas.logging.cloudwatch.local-address="..."

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.logging.cloudwatch.max-connections=10

Maximum connections setting.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.max-connections=10

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      max-connections: "10"

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 -Dcas.logging.cloudwatch.max-connections="10" -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_MAX_CONNECTIONS="10"

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 --cas.logging.cloudwatch.max-connections="10"

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.logging.cloudwatch.profile-name=

Profile name to use.

org.apereo.cas.configuration.model.support.aws.AmazonCloudWatchLogsProperties.

_{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:


1

cas.logging.cloudwatch.profile-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  logging: 
    cloudwatch: 
      profile-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 -Dcas.logging.cloudwatch.profile-name="..." -jar build/libs/cas.war

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

export CAS_LOGGING_CLOUDWATCH_PROFILE_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 --cas.logging.cloudwatch.profile-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.

Showing 1 to 5 of 16 entries

Previous1 2 3 4Next

# Allow CAS to add http request details into the logging's MDC filter.
# cas.logging.mdc.enabled=true

# A list of headers to exclude.
# cas.logging.mdc.headers-to-exclude=

# A list of parameters to exclude.
# cas.logging.mdc.parameters-to-exclude=

# Client execution timeout.
# cas.logging.cloudwatch.client-execution-timeout=10000

# Connection timeout.
# cas.logging.cloudwatch.connection-timeout=5000

# Local address.
# cas.logging.cloudwatch.local-address=

# Maximum connections setting.
# cas.logging.cloudwatch.max-connections=10

# Profile name to use.
# cas.logging.cloudwatch.profile-name=

# Profile path.
# cas.logging.cloudwatch.profile-path=

# Optionally specifies the proxy host to connect through.
# cas.logging.cloudwatch.proxy-host=

# Optionally specifies the proxy password to connect through.
# cas.logging.cloudwatch.proxy-password=

# Optionally specifies the proxy username to connect through.
# cas.logging.cloudwatch.proxy-username=

# Outline the requested retry mode.
# cas.logging.cloudwatch.retry-mode=STANDARD

# Socket timeout.
# cas.logging.cloudwatch.socket-timeout=5000

# Flag that indicates whether to use reaper.
# cas.logging.cloudwatch.use-reaper=false

# Map of resource labels to filter log entries.
# cas.logging.gcp.labels=

_{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.}

Show entries

Search:

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

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


1

logging.charset.console=...

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

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:


1

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:


1

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.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:


1

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.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:


1

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.

Showing 1 to 5 of 44 entries

Previous1 2 3 4 5…9Next

# 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=

# 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=

# The fully qualified class name of a StructuredLoggingJsonMembersCustomizer
# 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=

# 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, specially 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.