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.

CAS - Jaeger Distributed Tracing

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

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

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

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

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

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-tracing-jaeger"
}

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

cas.monitor.jaeger.connect-timeout=5s

Specifies the duration to wait for a connection to be established before timing out. This timeout applies to the initial connection phase and does not impact data transfer once the connection is established.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.connect-timeout=5s

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: 
  monitor: 
    jaeger: 
      connect-timeout: "5s"

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.monitor.jaeger.connect-timeout="5s" -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_MONITOR_JAEGER_CONNECT_TIMEOUT="5s"

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.monitor.jaeger.connect-timeout="5s"

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.monitor.jaeger.endpoint=http://localhost:4317

The GRPC endpoint to use when sending traces to the Jaeger server.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.endpoint=http://localhost:4317

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    jaeger: 
      endpoint: "http://localhost:4317"

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.monitor.jaeger.endpoint="http://localhost:4317" -jar build/libs/cas.war

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

export CAS_MONITOR_JAEGER_ENDPOINT="http://localhost:4317"

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.monitor.jaeger.endpoint="http://localhost:4317"

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.monitor.jaeger.headers=

A map of custom headers to be included in requests.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.headers=...

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    jaeger: 
      headers: "..."

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.monitor.jaeger.headers="..." -jar build/libs/cas.war

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

export CAS_MONITOR_JAEGER_HEADERS="..."

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.monitor.jaeger.headers="..."

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.monitor.jaeger.max-retry-attempts=3

Maximum number of retry attempts.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.max-retry-attempts=3

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    jaeger: 
      max-retry-attempts: "3"

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.monitor.jaeger.max-retry-attempts="3" -jar build/libs/cas.war

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

export CAS_MONITOR_JAEGER_MAX_RETRY_ATTEMPTS="3"

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.monitor.jaeger.max-retry-attempts="3"

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.monitor.jaeger.memory-mode=IMMUTABLE_DATA

Accepted values are: IMMUTABLE_DATA, MUTABLE_DATA.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.memory-mode=IMMUTABLE_DATA

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    jaeger: 
      memory-mode: "IMMUTABLE_DATA"

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.monitor.jaeger.memory-mode="IMMUTABLE_DATA" -jar build/libs/cas.war

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

export CAS_MONITOR_JAEGER_MEMORY_MODE="IMMUTABLE_DATA"

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.monitor.jaeger.memory-mode="IMMUTABLE_DATA"

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.monitor.jaeger.timeout=5s

The timeout to use when making requests to the Jaeger server.

org.apereo.cas.configuration.model.core.monitor.JaegerMonitorProperties.

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

cas.monitor.jaeger.timeout=5s

CAS properties can be specified using the YAML syntax:

cas: 
  monitor: 
    jaeger: 
      timeout: "5s"

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.monitor.jaeger.timeout="5s" -jar build/libs/cas.war

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

export CAS_MONITOR_JAEGER_TIMEOUT="5s"

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.monitor.jaeger.timeout="5s"

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.

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

management.opentelemetry.logging.export.otlp.compression=none

Method used to compress the payload.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.compression=none

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          compression: "none"

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 -Dmanagement.opentelemetry.logging.export.otlp.compression="none" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_COMPRESSION="none"

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 --management.opentelemetry.logging.export.otlp.compression="none"

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.

management.opentelemetry.logging.export.otlp.connect-timeout=10s

Connect timeout for the OTel collector connection.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.connect-timeout=10s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          connect-timeout: "10s"

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 -Dmanagement.opentelemetry.logging.export.otlp.connect-timeout="10s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_CONNECT_TIMEOUT="10s"

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 --management.opentelemetry.logging.export.otlp.connect-timeout="10s"

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.

management.opentelemetry.logging.export.otlp.endpoint=

URL to the OTel collector's HTTP API.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.endpoint=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          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 -Dmanagement.opentelemetry.logging.export.otlp.endpoint="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_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 --management.opentelemetry.logging.export.otlp.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.

management.opentelemetry.logging.export.otlp.headers=

Custom HTTP headers you want to pass to the collector, for example auth headers.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.headers=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          headers: "..."

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 -Dmanagement.opentelemetry.logging.export.otlp.headers="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_HEADERS="..."

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 --management.opentelemetry.logging.export.otlp.headers="..."

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.

management.opentelemetry.logging.export.otlp.timeout=10s

Call timeout for the OTel Collector to process an exported batch of data. This timeout spans the entire call: resolving DNS, connecting, writing the request body, server processing, and reading the response body. If the call requires redirects or retries all must complete within one timeout period.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.timeout=10s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          timeout: "10s"

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 -Dmanagement.opentelemetry.logging.export.otlp.timeout="10s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_TIMEOUT="10s"

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 --management.opentelemetry.logging.export.otlp.timeout="10s"

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.

management.opentelemetry.logging.export.otlp.transport=http

Transport used to send the logs.

org.springframework.boot.opentelemetry.autoconfigure.logging.otlp.OtlpLoggingProperties.

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

management.opentelemetry.logging.export.otlp.transport=http

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    logging: 
      export: 
        otlp: 
          transport: "http"

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 -Dmanagement.opentelemetry.logging.export.otlp.transport="http" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_LOGGING_EXPORT_OTLP_TRANSPORT="http"

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 --management.opentelemetry.logging.export.otlp.transport="http"

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.

management.opentelemetry.resource-attributes=

Resource attributes.

org.springframework.boot.opentelemetry.autoconfigure.OpenTelemetryProperties.

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

management.opentelemetry.resource-attributes=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    resource-attributes: "..."

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 -Dmanagement.opentelemetry.resource-attributes="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_RESOURCE_ATTRIBUTES="..."

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 --management.opentelemetry.resource-attributes="..."

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.

management.opentelemetry.tracing.export.include-unsampled=false

Whether unsampled spans should be exported.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.OpenTelemetryTracingProperties$Export.

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

management.opentelemetry.tracing.export.include-unsampled=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        include-unsampled: "..."

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 -Dmanagement.opentelemetry.tracing.export.include-unsampled="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_INCLUDE_UNSAMPLED="..."

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 --management.opentelemetry.tracing.export.include-unsampled="..."

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.

management.opentelemetry.tracing.export.max-batch-size=512

Maximum batch size for each export. This must be less than or equal to 'maxQueueSize'.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.OpenTelemetryTracingProperties$Export.

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

management.opentelemetry.tracing.export.max-batch-size=512

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        max-batch-size: "512"

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 -Dmanagement.opentelemetry.tracing.export.max-batch-size="512" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_MAX_BATCH_SIZE="512"

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 --management.opentelemetry.tracing.export.max-batch-size="512"

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.

management.opentelemetry.tracing.export.max-queue-size=2048

Maximum number of spans that are kept in the queue before they will be dropped.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.OpenTelemetryTracingProperties$Export.

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

management.opentelemetry.tracing.export.max-queue-size=2048

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        max-queue-size: "2048"

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 -Dmanagement.opentelemetry.tracing.export.max-queue-size="2048" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_MAX_QUEUE_SIZE="2048"

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 --management.opentelemetry.tracing.export.max-queue-size="2048"

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.

management.opentelemetry.tracing.export.otlp.compression=none

Method used to compress the payload.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.compression=none

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          compression: "none"

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 -Dmanagement.opentelemetry.tracing.export.otlp.compression="none" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_COMPRESSION="none"

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 --management.opentelemetry.tracing.export.otlp.compression="none"

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.

management.opentelemetry.tracing.export.otlp.connect-timeout=10s

Connect timeout for the OTel collector connection.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.connect-timeout=10s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          connect-timeout: "10s"

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 -Dmanagement.opentelemetry.tracing.export.otlp.connect-timeout="10s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_CONNECT_TIMEOUT="10s"

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 --management.opentelemetry.tracing.export.otlp.connect-timeout="10s"

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.

management.opentelemetry.tracing.export.otlp.endpoint=

URL to the OTel collector's HTTP API.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.endpoint=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          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 -Dmanagement.opentelemetry.tracing.export.otlp.endpoint="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_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 --management.opentelemetry.tracing.export.otlp.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.

management.opentelemetry.tracing.export.otlp.headers=

Custom HTTP headers you want to pass to the collector, for example auth headers.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.headers=...

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          headers: "..."

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 -Dmanagement.opentelemetry.tracing.export.otlp.headers="..." -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_HEADERS="..."

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 --management.opentelemetry.tracing.export.otlp.headers="..."

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.

management.opentelemetry.tracing.export.otlp.timeout=10s

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.timeout=10s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          timeout: "10s"

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 -Dmanagement.opentelemetry.tracing.export.otlp.timeout="10s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_TIMEOUT="10s"

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 --management.opentelemetry.tracing.export.otlp.timeout="10s"

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.

management.opentelemetry.tracing.export.otlp.transport=http

Transport used to send the spans.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.otlp.OtlpTracingProperties.

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

management.opentelemetry.tracing.export.otlp.transport=http

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        otlp: 
          transport: "http"

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 -Dmanagement.opentelemetry.tracing.export.otlp.transport="http" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_OTLP_TRANSPORT="http"

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 --management.opentelemetry.tracing.export.otlp.transport="http"

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.

management.opentelemetry.tracing.export.schedule-delay=5s

The delay interval between two consecutive exports.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.OpenTelemetryTracingProperties$Export.

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

management.opentelemetry.tracing.export.schedule-delay=5s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        schedule-delay: "5s"

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 -Dmanagement.opentelemetry.tracing.export.schedule-delay="5s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_SCHEDULE_DELAY="5s"

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 --management.opentelemetry.tracing.export.schedule-delay="5s"

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.

management.opentelemetry.tracing.export.timeout=30s

Maximum time an export will be allowed to run before being cancelled.

org.springframework.boot.micrometer.tracing.opentelemetry.autoconfigure.OpenTelemetryTracingProperties$Export.

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

management.opentelemetry.tracing.export.timeout=30s

CAS properties can be specified using the YAML syntax:

management: 
  opentelemetry: 
    tracing: 
      export: 
        timeout: "30s"

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 -Dmanagement.opentelemetry.tracing.export.timeout="30s" -jar build/libs/cas.war

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

export MANAGEMENT_OPENTELEMETRY_TRACING_EXPORT_TIMEOUT="30s"

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 --management.opentelemetry.tracing.export.timeout="30s"

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.

# Method used to compress the payload.
# management.opentelemetry.logging.export.otlp.compression=none

# Connect timeout for the OTel collector connection.
# management.opentelemetry.logging.export.otlp.connect-timeout=10s

# URL to the OTel collector's HTTP API.
# management.opentelemetry.logging.export.otlp.endpoint=

# Custom HTTP headers you want to pass to the collector, for example auth headers.
# management.opentelemetry.logging.export.otlp.headers=

# Call timeout for the OTel Collector to process an exported batch of data.
# management.opentelemetry.logging.export.otlp.timeout=10s

# Transport used to send the logs.
# management.opentelemetry.logging.export.otlp.transport=http

# Resource attributes.
# management.opentelemetry.resource-attributes=

# Whether unsampled spans should be exported.
# management.opentelemetry.tracing.export.include-unsampled=false

# Maximum batch size for each export.
# management.opentelemetry.tracing.export.max-batch-size=512

# Maximum number of spans that are kept in the queue before they will be dropped.
# management.opentelemetry.tracing.export.max-queue-size=2048

# Method used to compress the payload.
# management.opentelemetry.tracing.export.otlp.compression=none

# Connect timeout for the OTel collector connection.
# management.opentelemetry.tracing.export.otlp.connect-timeout=10s

# URL to the OTel collector's HTTP API.
# management.opentelemetry.tracing.export.otlp.endpoint=

# Custom HTTP headers you want to pass to the collector, for example auth headers.
# management.opentelemetry.tracing.export.otlp.headers=

# Call timeout for the OTel Collector to process an exported batch of data.
# management.opentelemetry.tracing.export.otlp.timeout=10s

# Transport used to send the spans.
# management.opentelemetry.tracing.export.otlp.transport=http

# The delay interval between two consecutive exports.
# management.opentelemetry.tracing.export.schedule-delay=5s

# Maximum time an export will be allowed to run before being cancelled.
# management.opentelemetry.tracing.export.timeout=30s

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.