Overview

Sentry allows you to track logs and error in real time. It provides insight into production deployments and information to reproduce and fix crashes.

The integration here supports error handling and reporting to Sentry, performance monitoring via spans and transactions as well as Sentry logging support.

Configuration

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

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


1

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

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

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

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-sentry"
}

The Logging configuration file must be adjusted to match the following:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="warn">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <!-- Setting minimumBreadcrumbLevel modifies the default minimum level to add breadcrumbs from INFO to DEBUG  -->
        <!-- Setting minimumEventLevel the default minimum level to capture an event from ERROR to WARN  -->
        <Sentry name="Sentry" 
                minimumBreadcrumbLevel="DEBUG"
                minimumEventLevel="WARN"
                dsn="..." />
    </Appenders>
    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="Sentry"/>
            <AppenderRef ref="casConsole"/>
        </Root>
    </Loggers>
</Configuration>

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

Third Party
Notes

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


No data available in table

Showing 0 to 0 of 0 entries

PreviousNext

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

sentry.attach-server-name=

io.sentry.spring.boot.jakarta.SentryProperties.

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

sentry.attach-server-name=...

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:

sentry: 
  attach-server-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 -Dsentry.attach-server-name="..." -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 SENTRY_ATTACH_SERVER_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 --sentry.attach-server-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.

sentry.attach-stacktrace=

io.sentry.spring.boot.jakarta.SentryProperties.

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

sentry.attach-stacktrace=...

CAS properties can be specified using the YAML syntax:

sentry: 
  attach-stacktrace: "..."

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 -Dsentry.attach-stacktrace="..." -jar build/libs/cas.war

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

export SENTRY_ATTACH_STACKTRACE="..."

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 --sentry.attach-stacktrace="..."

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.

sentry.attach-threads=

io.sentry.spring.boot.jakarta.SentryProperties.

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

sentry.attach-threads=...

CAS properties can be specified using the YAML syntax:

sentry: 
  attach-threads: "..."

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 -Dsentry.attach-threads="..." -jar build/libs/cas.war

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

export SENTRY_ATTACH_THREADS="..."

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 --sentry.attach-threads="..."

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.

sentry.backpressure-monitor=

io.sentry.spring.boot.jakarta.SentryProperties.

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

sentry.backpressure-monitor=...

CAS properties can be specified using the YAML syntax:

sentry: 
  backpressure-monitor: "..."

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

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

export SENTRY_BACKPRESSURE_MONITOR="..."

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 --sentry.backpressure-monitor="..."

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.

sentry.bundle-ids=

io.sentry.spring.boot.jakarta.SentryProperties.

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

sentry.bundle-ids=...

CAS properties can be specified using the YAML syntax:

sentry: 
  bundle-ids: "..."

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 -Dsentry.bundle-ids="..." -jar build/libs/cas.war

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

export SENTRY_BUNDLE_IDS="..."

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 --sentry.bundle-ids="..."

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 123 entries

Previous1 2 3 4 5…25Next

# 
# sentry.attach-server-name=

# 
# sentry.attach-stacktrace=

# 
# sentry.attach-threads=

# 
# sentry.backpressure-monitor=

# 
# sentry.bundle-ids=

# 
# sentry.cache-dir-path=

# 
# sentry.capture-open-telemetry-events=

# 
# sentry.composite-performance-collector=

# 
# sentry.connection-status-provider=

# 
# sentry.connection-timeout-millis=

# 
# sentry.context-tags=

# 
# sentry.continuous-profiler=

# 
# sentry.cron.default-checkin-margin=

# 
# sentry.cron.default-failure-issue-threshold=

# 
# sentry.cron.default-max-runtime=

# 
# sentry.cron.default-recovery-threshold=

# 
# sentry.cron.default-timezone=

# 
# sentry.date-provider=

# 
# sentry.debug=

# 
# sentry.debug-meta-loader=

# 
# sentry.default-scope-type=

# 
# sentry.diagnostic-level=

# 
# sentry.dist=

# 
# sentry.distinct-id=

# 
# sentry.dsn=

# If set to true, this flag disables all AOP related features (e.g.
# sentry.enable-aot-compatibility=false

# 
# sentry.enable-app-start-profiling=

# 
# sentry.enable-auto-session-tracking=

# 
# sentry.enable-backpressure-handling=

# 
# sentry.enable-deduplication=

# 
# sentry.enable-external-configuration=

# 
# sentry.enable-pretty-serialization-output=

# 
# sentry.enable-scope-persistence=

# 
# sentry.enable-screen-tracking=

# 
# sentry.enable-shutdown-hook=

# 
# sentry.enable-spotlight=

# 
# sentry.enable-time-to-full-display-tracing=

# 
# sentry.enable-uncaught-exception-handler=

# 
# sentry.enable-user-interaction-breadcrumbs=

# 
# sentry.enable-user-interaction-tracing=

# 
# sentry.enabled=

# 
# sentry.envelope-disk-cache=

# 
# sentry.envelope-reader=

# 
# sentry.environment=

# 
# sentry.event-processors=

# Report all or only uncaught web exceptions.
# sentry.exception-resolver-order=1

# 
# sentry.executor-service=

# 
# sentry.flush-timeout-millis=

# 
# sentry.force-init=

# 
# sentry.fully-displayed-reporter=

# 
# sentry.gesture-target-locators=

# 
# sentry.global-hub-mode=

# List of error types the Sentry Graphql integration should ignore.
# sentry.graphql.ignored-error-types=

# 
# sentry.idle-timeout=

# 
# sentry.ignored-check-ins=

# 
# sentry.ignored-errors=

# 
# sentry.ignored-exceptions-for-type=

# 
# sentry.ignored-span-origins=

# 
# sentry.ignored-transactions=

# 
# sentry.in-app-excludes=

# 
# sentry.in-app-includes=

# 
# sentry.init-priority=

# 
# sentry.instrumenter=

# 
# sentry.integrations=

# 
# sentry.keep-transactions-open-for-async-responses=false

# 
# sentry.logger=

# Enable/Disable logging auto-configuration.
# sentry.logging.enabled=true

# List of loggers the SentryAppender should be added to.
# sentry.logging.loggers=

# Minimum logging level for recording breadcrumb.
# sentry.logging.minimum-breadcrumb-level=

# Minimum logging level for recording event.
# sentry.logging.minimum-event-level=

# 
# sentry.max-attachment-size=

# 
# sentry.max-breadcrumbs=

# 
# sentry.max-cache-items=

# 
# sentry.max-depth=

# 
# sentry.max-queue-size=

# 
# sentry.max-request-body-size=

# 
# sentry.max-spans=

# 
# sentry.max-trace-file-size=

# 
# sentry.modules-loader=

# 
# sentry.open-telemetry-mode=

# 
# sentry.options-observers=

# 
# sentry.performance-collectors=

# 
# sentry.print-uncaught-stack-trace=

# 
# sentry.profiles-sample-rate=

# 
# sentry.profiling-traces-hz=

# 
# sentry.proguard-uuid=

# 
# sentry.proxy.host=

# 
# sentry.proxy.pass=

# 
# sentry.proxy.port=

# 
# sentry.proxy.type=

# 
# sentry.proxy.user=

# Enable/Disable usage of {@link io.micrometer.context.ThreadLocalAccessor} for Scopes propagation
# sentry.reactive.thread-local-accessor-enabled=true

# 
# sentry.read-timeout-millis=

# 
# sentry.release=

# 
# sentry.replay-controller=

# 
# sentry.sample-rate=

# 
# sentry.scope-observers=

# 
# sentry.sdk-version=

# 
# sentry.send-client-reports=

# 
# sentry.send-default-pii=

# 
# sentry.send-modules=

# 
# sentry.sentry-client-name=

# 
# sentry.serializer=

# 
# sentry.server-name=

# 
# sentry.session-flush-timeout-millis=

# 
# sentry.session-replay=

# 
# sentry.session-tracking-interval-millis=

# 
# sentry.shutdown-timeout-millis=

# 
# sentry.span-factory=

# 
# sentry.spotlight-connection-url=

# 
# sentry.ssl-socket-factory=

# 
# sentry.tags=

# 
# sentry.thread-checker=

# 
# sentry.trace-options-requests=

# 
# sentry.trace-propagation-targets=

# 
# sentry.trace-sampling=

# 
# sentry.traces-sample-rate=

# 
# sentry.transaction-profiler=

# 
# sentry.transport-factory=

# 
# sentry.transport-gate=

# Whether to use Git commit id as a release.
# sentry.use-git-commit-id-as-release=true

# Defines the {@link io.sentry.spring.SentryUserFilter} order.
# sentry.user-filter-order=

# 
# sentry.view-hierarchy-exporters=

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.

Breadcrumbs are kept in memory (by default the last 100 records) and are sent with events. For example, by default, if you log 100 entries with logger.info or logger.warn, no event is sent to Sentry. If you then log with logger.error, an event is sent to Sentry that includes those 100 info or warn messages. For this to work, SentryAppender needs to receive all log entries to decide what to keep as breadcrumb or send as event. Set the SentryAppender log level configuration to a value lower than what is set for the minimumBreadcrumbLevel and minimumEventLevel so that it receives these log messages.

Finally, you will need to configure your DSN (client key) and optionally other values such as environment and release.

You can do so in a src/main/resources/sentry.properties file:

dsn=https://12345@12345.ingest.sentry.io/12345

Or via system properties when you launch CAS:

java -Dsentry.dsn=https://12345@12345.ingest.sentry.io/12345 ...

Or via environment variables before you launch CAS:

export SENTRY_DSN=https://12345@12345.ingest.sentry.io/12345