APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Google Cloud Logging

Cloud Logging is the managed logging service provided by Google Cloud.

The integration here also provides automatic support for associating a web request trace ID with the corresponding log entries by retrieving the X-B3-TraceId or X-Cloud-Trace-Context header values from MDC.

JSON Layout Template

JsonTemplateLayout is a customizable, efficient, and garbage-free JSON generating layout. It encodes LogEvents according to the structure described by the JSON template provided.



1



<JsonTemplateLayout eventTemplateUri="classpath:GcpLayout.json"/>

CAS

Another option is to use a CAS-provided dedicated logger. Support is enabled by including the following dependency in the WAR overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



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





1



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





1
2
3
4
5
6
7
8
9



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

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





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed 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-gcp-logging"
}
:information_source: Usage

Due to the way logging is set up, the Google Cloud project ID and credentials defined in CAS properties are ignored. Instead, you should set the GOOGLE_CLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS environment variables to the project ID and credentials private key location, where necessary. Alternatively, the Google Cloud project ID can also be set directly in the logging configuration.

This is an example of the logging configuration:



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35



<Configuration>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <JsonLayout locationInfo="false"
                        includeStacktrace="true"
                        objectMessageAsJsonObject="true"
                        compact="true"
                        properties="false"
                        eventEol="true"
                        includeTimeMillis="false">
                <KeyValuePair key="time" value="$${event:timestamp:-}"/>
                <KeyValuePair key="timestampSeconds" value="$${ctx:timestampSeconds:-}"/>
                <KeyValuePair key="timestampNanos" value="$${ctx:timestampNanos:-}"/>
                <KeyValuePair key="severity" value="$${ctx:severity:-}"/>
                <KeyValuePair key="logging.googleapis.com/insertId" value="$${ctx:insertId:-}"/>
                <KeyValuePair key="logging.googleapis.com/spanId" value="$${ctx:spanId:-}"/>
                <KeyValuePair key="logging.googleapis.com/trace" value="$${ctx:traceId:-}"/>
            </JsonLayout>
        </Console>
        <!-- Update the projectId, or remove and let CAS determine the project id automatically -->
        <GoogleCloudAppender name="GoogleCloudAppender" 
                             flattenMessage="true"
                             projectId="...">
            <AppenderRef ref="casConsole"/>
        </GoogleCloudAppender>
    </Appenders>

    <Loggers>
        <Logger name="org.apereo.cas" includeLocation="true" 
                level="INFO" additivity="false">
            <AppenderRef ref="GoogleCloudAppender"/>
        </Logger>
    </Loggers>

</Configuration>

Actuator Endpoints

The following endpoints are provided by CAS:

gcpLogs
CAS endpoint1 operationNot exposed by default
1

Turn the endpoint on and expose it over the web. One entry covers every operation. By default only info, health and status are exposed.



1
2



management.endpoint.gcpLogs.access=UNRESTRICTED
management.endpoints.web.exposure.include=gcpLogs

Endpoints may be mapped to other paths. For example, to serve health at healthcheck:



1



management.endpoints.web.path-mapping.health=healthcheck

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

cas.logging.gcp.log-nameIn Google Cloud Logging, the log name is an identifier that specifies the particular log to which log entries are written or from which they are retrieved.
no default
Required

In Google Cloud Logging, the log name is an identifier that specifies the particular log to which log entries are written or from which they are retrieved. It is an essential component when interacting with logs using the Google Cloud Logging API, as it allows you to target specific logs for querying or analysis.

It typically has the following syntax: projects/[PROJECT_ID]/logs/[LOG_ID]

Type
String
Default
none
Defined by
GoogleCloudLogsProperties
cas.logging.gcp.project-idA Project ID is a unique identifier assigned to a specific project within your GCP environment.
no default
Required

A Project ID is a unique identifier assigned to a specific project within your GCP environment. The Project ID is globally unique across all GCP projects, meaning no two projects can have the same Project ID. The Project ID is used in various API calls, configurations, and URLs to uniquely identify your CAS project.

Type
String
Default
none
Defined by
GoogleCloudLogsProperties
cas.logging.gcp.labelsMap of resource labels to filter log entries.
no default

Map of resource labels to filter log entries. Key is the resource label name, and value is the actual label itself.

Type
Map<String,String>
Default
none
Defined by
GoogleCloudLogsProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

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.

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

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.