APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

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

CAS - Distributed Tracing

CAS ships auto configuration for the following tracers:

Platform Reference
OpenTelemetry See this guide.
Zipkin Brave See this guide.
Jaeger See this guide.

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

management.tracing.baggage.correlation.enabledWhether to enable correlation of the baggage context with logging contexts.
true
Third party

Whether to enable correlation of the baggage context with logging contexts.

Type
Boolean
Default
true
Defined by
TracingProperties$Baggage$Correlation
management.tracing.baggage.correlation.fieldsList of fields that should be correlated with the logging context.
no default
Third party

List of fields that should be correlated with the logging context. That means that these fields would end up as key-value pairs in e.g. MDC.

Type
List<String>
Default
none
Defined by
TracingProperties$Baggage$Correlation
management.tracing.baggage.enabledWhether to enable Micrometer Tracing baggage propagation.
true
Third party

Whether to enable Micrometer Tracing baggage propagation.

Type
Boolean
Default
true
Defined by
TracingProperties$Baggage
management.tracing.baggage.local-fieldsList of fields that should be accessible within the JVM process but not propagated over the wire.
no default
Third party

List of fields that should be accessible within the JVM process but not propagated over the wire. Local fields are not supported with OpenTelemetry.

Type
List<String>
Default
none
Defined by
TracingProperties$Baggage
management.tracing.baggage.remote-fieldsList of fields that are referenced the same in-process as it is on the wire.
no default
Third party

List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix.

Type
List<String>
Default
none
Defined by
TracingProperties$Baggage
management.tracing.baggage.tag-fieldsList of fields that should automatically become tags.
no default
Third party

List of fields that should automatically become tags.

Type
List<String>
Default
none
Defined by
TracingProperties$Baggage
management.tracing.enabled
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.tracing.export.enabled
management.tracing.exemplars.includeTraces to include as exemplars.
sampled-traces
Third party

Traces to include as exemplars. 'all' is not supported when using Prometheus.

Type
TracingProperties.Exemplars.Include
Default
sampled-traces
Defined by
TracingProperties$Exemplars
management.tracing.export.enabledWhether auto-configuration of tracing is enabled to export and propagate traces.
true
Third party

Whether auto-configuration of tracing is enabled to export and propagate traces.

Type
Boolean
Default
true
management.tracing.export.otlp.enabledWhether auto-configuration of tracing is enabled to export OTLP traces.
true
Third party

Whether auto-configuration of tracing is enabled to export OTLP traces.

Type
Boolean
Default
true
management.tracing.mdc.span-id-keyKey under which the span ID is added to the org.slf4j.MDC .
spanId
Third party

Key under which the span ID is added to the org.slf4j.MDC.

Type
String
Default
spanId
Defined by
TracingProperties$Mdc
management.tracing.mdc.trace-id-keyKey under which the trace ID is added to the org.slf4j.MDC .
traceId
Third party

Key under which the trace ID is added to the org.slf4j.MDC.

Type
String
Default
traceId
Defined by
TracingProperties$Mdc
management.tracing.opentelemetry.export.include-unsampled
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.opentelemetry.tracing.export.include-unsampled
management.tracing.opentelemetry.export.max-batch-size
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.opentelemetry.tracing.export.max-batch-size
management.tracing.opentelemetry.export.max-queue-size
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.opentelemetry.tracing.export.max-queue-size
management.tracing.opentelemetry.export.schedule-delay
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.opentelemetry.tracing.export.schedule-delay
management.tracing.opentelemetry.export.timeout
no default
Third partyDeprecated
Default
none
Deprecation
ERROR, replaced by management.opentelemetry.tracing.export.timeout
management.tracing.propagation.consumeTracing context propagation types consumed by the application.
["W3C", "B3", "B3_MULTI"]
Third party

Tracing context propagation types consumed by the application.

Type
List<TracingProperties.Propagation.PropagationType>
Default
["W3C", "B3", "B3_MULTI"]
Defined by
TracingProperties$Propagation
management.tracing.propagation.produceTracing context propagation types produced by the application.
["W3C"]
Third party

Tracing context propagation types produced by the application.

Type
List<TracingProperties.Propagation.PropagationType>
Default
["W3C"]
Defined by
TracingProperties$Propagation
management.tracing.propagation.typeTracing context propagation types produced and consumed by the application.
no default
Third party

Tracing context propagation types produced and consumed by the application. Setting this property overrides the more fine-grained propagation type properties.

Type
List<TracingProperties.Propagation.PropagationType>
Default
none
Defined by
TracingProperties$Propagation
management.tracing.sampling.probabilityProbability in the range from 0.0 to 1.0 that a trace will be sampled.
0.1
Third party

Probability in the range from 0.0 to 1.0 that a trace will be sampled.

Type
Float
Default
0.1
Defined by
TracingProperties$Sampling

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.