Pod Storage Service#

Changed in version 2.0.

Starting in ESS 2.0, Pod provisioning and storage is handled by a separate Pod Provisioning Service and Pod Storage Service.

ESS’ Pod storage service hosts the Pods created by the Pod provisioning service and is responsible for reading and writing the resources stored in the Pod.

The Pod URL has the following pattern:

https://storage.{ESS Domain}/{Unique Root Container}/

Prior to version 2.0, ESS Pods had the URL of the form https://{ESS Domain}/{username}/

Pod Resources#

ESS Pods supports storing different types of Solid Resources, including:

  • a Container

    Analogous to folders in a file system. A Container can contain other Containers as well as RDF and non-RDF resources. Container URLs always end with a slash /.

  • a Resource Description Framework (RDF) resource.

    A file whose contents consists of statements (also known as triples) that describe some “subject” by its relationships:

    <subject> <predicate> <object>
    
  • a non-RDF Resource

    Any non-RDF binary or text file, such as .pdf , .jpeg, etc.

See also Pod Resources.

Access#

For access to the Pod resources, ESS’ Pod Storage service supports the use of the following tokens:

See also:

Discovery#

ESS provides Pod storage service (and related) metadata at the following .well-known/solid URI:

https://storage.{ESS Domain}/.well-known/solid

Its Response.body returns Resource Description Framework (RDF) statements. Depending on your configuration, the response can include information about:

@prefix solid: <http://www.w3.org/ns/solid/terms#> .

[ a                          solid:DiscoveryDocument ;
  <http://www.w3.org/ns/auth/acl#trustedApp>
          <https://podbrowser.inrupt.com/api/app> ;
  solid:maxPodsPerOwner      10 ;
  solid:notificationGateway  <https://notification.{ESS DOMAIN}.com/> ;
  solid:provision            <https://provision.{ESS DOMAIN}.com/>;
  solid:qpf                  <https://fragments.{ESS DOMAIN}.com/
] .

Prune/Hard Delete Feature#

New in version 2.1.

Starting in 2.1, ESS includes a Prune feature to hard delete (i.e., permanently delete):

For more information on soft-deleted resources and orphan data, see CRUD Operations.

Prune CronJobs#

Prune consists of two Kubernetes CronJobs :

Pruning Soft-Deleted Resources#

Prune uses the following process to delete soft-deleted resources:

  1. To find resources to delete, Prune queries for metadata entries that have been soft-deleted (i.e., marked as deleted) for longer than the configured INRUPT_STORAGE_PRUNE_RETENTION_WINDOW. These are “prunable” resources.

    Prune uses the INRUPT_STORAGE_PRUNE_PRUNABLE_BATCH_SIZE to limit the number of results.

  2. Using the identifiers (part of the metadata) from the query results,

    1. Prune deletes the resources.

    2. Prune deletes the associated metadata.

To configure, see Modify Prune Configuration.

See also Administration: Pruning.

Pruning Orphan Data#

Prune uses the following process to delete orphan data:

  1. Prune starts by randomly selecting resource data identifiers.

    Prune uses the INRUPT_STORAGE_PRUNE_ORPHAN_BATCH_SIZE to limit the number of selected identifiers.

  2. For the selected resource data identifiers, Prune queries for corresponding metadata to find those identifiers without corresponding metadata.

    Prune uses the INRUPT_STORAGE_PRUNE_PRUNABLE_BATCH_SIZE to limit the number of results.

  3. Prune deletes those resource data whose identifiers did not have corresponding metadata.

To configure, see Modify Prune Configuration.

See also Administration: Pruning.

Storage Metrics#

Starting in 2.1, ESS includes a Storage Metrics feature to gather the following metrics:

  • The total number of Pods

  • The number of Pods that have been “Created” (where the provision has been confirmed)

  • The number of Pods that have been “Deleted”(marked for deletion; i.e., soft-deleted).

The Storage Metrics is run as a Kubernetes CronJobs.

To modify the schedule, see Modify Storage Metrics Schedule.

See also Administration: Storage Metrics.

Configuration#

As part of the installation process, Inrupt provides base Kustomize overlays and associated files that require deployment-specific configuration inputs.

The following configuration options are available for the service and may be set as part of updating the inputs for your deployment. The Inrupt-provided base Kustomize overlays may be using updated configuration values that differ from the default values.

Pod Storage Pruning Options#

COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE#

Default: 5000

Optional. The maximum amount of milliseconds Prune operations’ connection to the metadata database can remain open.

Adjust as needed to accommodate changes to:

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW#

Default: inrupt,quarkus.s3.aws.region

A comma-separated list of configuration property prefixes (case-sensitive) that determine which configurations are logged:

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

Tip

To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example:

  • If using dot-notation, if you want to match configuration properties of the form foobar.<xxxx>..., specify foobar. (including the dot .) instead of, for example, foo or foobar.

  • If using converted form, if you want to match configuration properties of the form FOOBAR_<XXXX>..., specify FOOBAR_ (including the underscore _) instead of, for example, FOO or FOOBAR.

New in version 2.2.0.

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY#

Default:

A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW) are not logged. That is, INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW. For example:

  • If foobar. is an allowed prefix, to suppress foobar.private.<anything>, you can specify foobar.private. to the deny list.

  • If foobar. is not an allowed prefix, no property starting with foobar. is logged. As such, you do not need to specify foobar.private to the deny list.

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

New in version 2.2.0.

INRUPT_STORAGE_PRUNE_ORPHAN_BATCH_SIZE#

An integer that limits the number of resource data identifiers selected by Prune during orphan data cleanup.

Important

For Prune cron job that prunes soft-deleted resources, set to 0.

An increase in the batch size may require a corresponding increase in COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE.

INRUPT_STORAGE_PRUNE_PRUNABLE_BATCH_SIZE#

An integer that limits the number of results returned when querying the metadata.

Important

For Prune cron job that prunes orphan data, set to 0.

An increase in the batch size may require a corresponding increase in COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE.

INRUPT_STORAGE_PRUNE_RETENTION_WINDOW#

The minimum amount of time (specified in a format supported by Java Duration.parse() method; e.g., PT23H for 23 hours) that resources have been soft-deleted (marked as deleted) before they become eligible for pruning. That is, resources that have been soft-deleted for longer than the specified time can be selected for hard deletion by Prune; i.e., these are “prunable” resources.

This configuration does not affect the pruning of orphaned data.

An increase in the retention window value may require a corresponding increase in COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE.

To configure Prune, see Modify Prune Configuration.

Pod Storage Metrics Options#

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW#

Default: inrupt,quarkus.s3.aws.region

A comma-separated list of configuration property prefixes (case-sensitive) that determine which configurations are logged:

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

Tip

To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example:

  • If using dot-notation, if you want to match configuration properties of the form foobar.<xxxx>..., specify foobar. (including the dot .) instead of, for example, foo or foobar.

  • If using converted form, if you want to match configuration properties of the form FOOBAR_<XXXX>..., specify FOOBAR_ (including the underscore _) instead of, for example, FOO or FOOBAR.

New in version 2.2.0.

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY#

Default:

A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW) are not logged. That is, INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW. For example:

  • If foobar. is an allowed prefix, to suppress foobar.private.<anything>, you can specify foobar.private. to the deny list.

  • If foobar. is not an allowed prefix, no property starting with foobar. is logged. As such, you do not need to specify foobar.private to the deny list.

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

New in version 2.2.0.

To configure Storage Metrics, see Modify Storage Metrics Schedule.

Pod Storage Resource Read Auditing Option#

INRUPT_STORAGE_AUDIT_RESOURCE_READ_ENABLED#

Default: false

A boolean that determines whether to audit successful read resource events (i.e., successful (GET and HEAD operations on resources).

Set to true to enable, and false to disable.

Important

When auditing of read operations is enabled, the total number of Audit events may increase substantially. Before enabling read operations auditing, consider allocating more compute and network resources to ESS.

See also Enable Resource Read Auditing.

New in version 2.1.

Pod Storage UMA Configuration#

INRUPT_AUTHZ_AS_URI#

The URI of the UMA Authorization Server.

The value must match:

INRUPT_AUTHZ_UMA_ANONYMOUS_ENABLED#

Default: false

A boolean flag that determines whether to support anonymous (i.e., unauthenticated) access to resources that have been granted public access.

Important

If set to true (i.e., allow unauthenticated access to resources that have been granted public access), update the service’s Content-Security-Policy (default worker-src 'none') to include Content-Security-Policy (CSP) sandbox, such as Content-Security-Policy: worker-src 'none'; sandbox allow-scripts.

You can use Quarkus HTTP configuration property to add the CSP header setting; namely QUARKUS_HTTP_HEADERS__CONTENT_SECURITY_POLICY__VALUE.

INRUPT_AUTHZ_UMA_OIDC_ENABLED#

Default: false

A boolean flag that determines whether the Pod server supports OIDC access tokens. When set to false, clients will need access tokens from the associated UMA server.

INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER#

The URI of the UMA token issuer.

The value must match INRUPT_AUTHZ_AS_URI.

INRUPT_JWT_AUTHORIZATION_SERVER_JWKS#

The JWKS endpoint of the INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER.

SMALLRYE_JWT_ENCRYPT_KEY_ID#

The key id of the JWK key used to encrypt the ticket for the UMA Authorization Server. Required if using UMA.

SMALLRYE_JWT_ENCRYPT_KEY_LOCATION#

The location of the JWK key used to encrypt the ticket for the UMA Service. This should be configured to the SMALLRYE_JWT_SIGN_KEY_LOCATION on the UMA Service.

Pod Storage Options#

INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST#

Default: https://podbrowser.inrupt.com/api/app

Comma-delimited list of Client IDs that are displayed in /.well-known/solid as the Client IDs of trusted applications. Trusted applications can perform read and write operations on the Access Control Resources.

Disambiguation

Both Authorization Service and Pod Storage Service have an INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST setting.

Only the Authorization Service setting affects which clients are allowed. The Pod Storage Service is for Discovery purposes only.

The list should reflect the values set in the Authorization Service‘s INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST since the authorization server’s configuration actually determines what clients are the trusted applications. That is, the Pod service’s configuration is for discoverability purposes only.

See Set Authorization Client Allow List.

INRUPT_STORAGE_HTTP_BASE_URL#

The base URL of the storage service. This is mainly for use by supporting services like Pod Provisioning service.

Important

INRUPT_STORAGE_HTTP_CACHE_CONTROL_MAX_AGE#

Default: 0

The max-age directive value on the Cache-Control header.

For more information of Cache-Control directives, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control.

Solid-OIDC Issuer Configuration Options#

INRUPT_JWT_ALLOWED_SIGNATURE_ALGORITHMS#

Default: ES256, RS256

A comma-separated list that specifies the allowed encryption algorithms used to sign ID tokens.

INRUPT_JWT_ISSUER_ALLOW_LIST#

A comma-separated list of trusted issuers of Solid-OIDC tokens.

See also INRUPT_JWT_ISSUER_DENY_LIST.

Tip

Ensure that ESS UMA service’ INRUPT_JWT_ISSUER_ALLOW_LIST is consistent with the INRUPT_JWT_ISSUER_ALLOW_LIST value set for this service.

INRUPT_JWT_ISSUER_DENY_LIST#

A comma-separated list of disallowed issuers of Solid-OIDC tokens.

Tip

Ensure that ESS’ UMA service’s INRUPT_JWT_ISSUER_DENY_LIST is consistent with the INRUPT_JWT_ISSUER_DENY_LIST value set for this service.

JSON-LD Context Configuration Options#

INRUPT_JSONLD_CONTEXT_ALLOW_LIST#

A comma-delimited list of trusted JSON-LD context URIs allowed to be dereferenced.

INRUPT_JSONLD_CONTEXT_DENY_LIST#

A deny-list of JSON-LD context URIs. URIs listed in this configuration are prevented from being dereferenced.

See also: INRUPT_JSONLD_CONTEXT_ALLOW_LIST.

Logging Configuration#

QUARKUS_LOG_LEVEL#

Default: INFO

Logging level.

Kafka Configuration#

INRUPT_KAFKA_AUDITV1EVENTSENCRYPTED_CIPHER_PASSWORD#

The strong cipher key to use when running auditing with encrypted messages over the auditv1eventsencrypted topic.

INRUPT_KAFKA_AUDITV1EVENTSPRODUCERENCRYPTED_CIPHER_PASSWORD#

The strong cipher key to use when running auditing with encrypted messages over the auditv1eventsproducerencrypted topic.

New in version 2.2.0.

INRUPT_KAFKA_SOLIDRESOURCE_CIPHER_PASSWORD#

The symmetric key to use when encrypting messages (see MP_MESSAGING_OUTGOING_SOLIDRESOURCE_VALUE_SERIALIZER).

KAFKA_BOOTSTRAP_SERVERS#

Default: localhost:9092

Comma-delimited list of Kafka broker servers for use by ESS services, including this service.

Setting KAFKA_BOOTSTRAP_SERVERS configures ESS to use the same Kafka instance(s) for all its Kafka message channels (e.g., solidresource and auditv1out message channels). The Pod management services use the solidresource and auditv1out message channels.

Note

Inrupt-provided overlays default to using KAFKA_BOOTSTRAP_SERVERS.

To use a different Kafka instance for the solidresource and auditv1out channels, use MP_MESSAGING_OUTGOING_SOLIDRESOURCE_BOOTSTRAP_SERVERS and MP_MESSAGING_OUTGOING_AUDITV1OUT_BOOTSTRAP_SERVERS instead.

See also ESS’ Kafka Configuration.

MP_MESSAGING_OUTGOING_AUDITV1OUT_BOOTSTRAP_SERVERS#

Default: localhost:9092

Comma-delimited list of Kafka broker servers used for the outgoing audit v1 messages.

These messages are sent over the auditv1out message channel.

Note

To configure ESS to use the same Kafka instances for all its Kafka message channels, use KAFKA_BOOTSTRAP_SERVERS option instead. Inrupt-provided overlays default to using KAFKA_BOOTSTRAP_SERVERS.

MP_MESSAGING_OUTGOING_SOLIDRESOURCE_BOOTSTRAP_SERVERS#

Default: localhost:9092

Comma-delimited list of Kafka broker servers used for the outgoing resource notification messages.

These messages are sent over the solidresource message channel.

Note

To configure ESS to use the same Kafka instances for all its Kafka message channels, use KAFKA_BOOTSTRAP_SERVERS option instead. Inrupt-provided overlays default to using KAFKA_BOOTSTRAP_SERVERS.

MP_MESSAGING_OUTGOING_SOLIDRESOURCE_VALUE_SERIALIZER#

Default: org.apache.kafka.common.serialization.StringSerializer

The serializer used for the notification messages the service sends to Kafka.

Supported values are:

  • org.apache.kafka.common.serialization.StringSerializer

    When set to this value, notification messages sent to Kafka are unencrypted.

    Services that consume these messages (e.g., WebSocket Notification Service) will need to set their MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER to the corresponding deserializer value org.apache.kafka.common.serialization.StringDeserializer.

  • com.inrupt.components.kafka.encryption.EncryptMessageSerializer

    When set to this value, notification messages sent to Kafka are encrypted. Services that consume these encrypted messages (e.g., WebSocket Notification Service) will need to set their MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER configuration to the corresponding deserializer value com.inrupt.components.kafka.encryption.DecryptMessageDeserializer.

AWS Options#

INRUPT_STORAGE_S3_BUCKET_NAME#

Default: inrupt.ess.storage

The name of the S3 bucket used for storage.

QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID#

AWS Access key id.

QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY#

AWS Secret access key.

QUARKUS_S3_AWS_REGION#

An Amazon Web Services region that hosts the S3 Bucket.

QUARKUS_S3_ENDPOINT_OVERRIDE#

Override S3 endpoint URL.

OpenTelemetry Options#

QUARKUS_OPENTELEMETRY_TRACER_EXPORTER_OTLP_ENABLED#

Default: false

Build time configuration. Will be removed from the docs at a future date

The OpenTelemetry exporter can be enabled or disabled with this configuration.

QUARKUS_OPENTELEMETRY_TRACER_EXPORTER_OTLP_ENDPOINT#

Build time configuration. Will be removed from the docs at a future date

The URL of the OpenTelemetry exporter.

Configuration Logging#

Starting in 2.2, ESS services log their startup configuration.

INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW#

Default: inrupt,smallrye.jwt.expiration.grace,mp.jwt.verify.clock.skew,smallrye.jwt.always-check-authorization,smallrye.jwt.token.decryption.kid,smallrye.jwt.token.schemes,smallrye.jwt.require.named-principal,smallrye.jwt.time-to-live,smallrye.jwt.jwks.refresh-interval,smallrye.jwt.jwks.forced-refresh-interval,smallrye.jwt.required.claims,mp.jwt.verify.audiences

A comma-separated list of configuration property prefixes (case-sensitive) that determine which configurations are logged:

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

Tip

To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example:

  • If using dot-notation, if you want to match configuration properties of the form foobar.<xxxx>..., specify foobar. (including the dot .) instead of, for example, foo or foobar.

  • If using converted form, if you want to match configuration properties of the form FOOBAR_<XXXX>..., specify FOOBAR_ (including the underscore _) instead of, for example, FOO or FOOBAR.

New in version 2.2.0.

INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY#

Default: inrupt.kafka

A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW) are not logged. That is, INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY acts as a filter on INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW. For example:

  • If foobar. is an allowed prefix, to suppress foobar.private.<anything>, you can specify foobar.private. to the deny list.

  • If foobar. is not an allowed prefix, no property starting with foobar. is logged. As such, you do not need to specify foobar.private to the deny list.

When specifying the prefixes, you can specify the prefixes using one of two formats:

Warning

Use the same format for both INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW and INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY.

For example, if you change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW, change the format of INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY as well.

New in version 2.2.0.

Logging Redaction#

INRUPT_LOGGING_REDACTION_NAME_ACTION#

Default: REPLACE

Type of the redaction to perform. Supported values are:

Action

Description

REPLACE

Default. Replaces the matching text with a specified replacement.

PLAIN

Leaves the matching field unprocessed. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).

DROP

Suppresses the matching field. Only available if the redaction target is a field (i.e., INRUPT_LOGGING_REDACTION_{NAME}_FIELD).

PRIORITIZE

Changes the log level of the matching message.

SHA256

Replaces the matching text with its hash.

  • If the action is REPLACE (default), see also INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT.

  • If the action is to PRIORITIZE, see also INRUPT_LOGGING_REDACTION_{NAME}_LEVEL.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_ENABLED#

Default: true

A boolean that determines whether the redaction configurations with the specified INRUPT_LOGGING_REDACTION_{NAME}_ prefix is enabled.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_EXCEPTION#

Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_FIELD#

Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_LEVEL#

A new log level to use for the log message if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is PRIORITIZE.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_PATTERN#

A regex (see Java regex pattern) to match in the log messages. Configure to target log message text that matches a specified pattern.

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

INRUPT_LOGGING_REDACTION_NAME_REPLACEMENT#

Replacement text to use if the INRUPT_LOGGING_REDACTION_{NAME}_ACTION is REPLACE.

If unspecified, defaults to [REDACTED].

For more information on log redaction, see Logging Redaction.

New in version 2.2.0.

Application-Defined Metadata Propagation#

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW#

A comma-separated list of application-defined properties that can be included in the associated audit events (unless specified in the corresponding INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

New in version 2.2.0.

INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY#

A comma-separated list of application-defined properties to exclude from the associated audit messages. This setting takes precedence over INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

New in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_ALLOW#

A comma-separated list of application-defined properties that can be included in the associated log messages (unless specified in the corresponding INRUPT_LOGGING_REQUEST_METADATA_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To include a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

New in version 2.2.0.

INRUPT_LOGGING_REQUEST_METADATA_DENY#

A comma-separated list of application-defined properties to exclude from the associated log messages. This setting takes precedence over INRUPT_LOGGING_REQUEST_METADATA_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW#

A comma-separated list of non-baggage request headers to add to the baggage (unless specified in the corresponding INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY); i.e., include these non-baggage request headers as application-defined properties.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY#

A comma-separated list of non-baggage request headers to exclude from being added to the baggage; i.e., excludes these headers as application-defined properties. This setting takes precedence over INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW.

The configuration is case-insensitive; i.e., the listed headers do not need to match the case of the client request headers. For example, a list that includes x-correlation-id can match (and exclude) x-correlation-id header, X-CoRrElAtIoN-Id header, etc.

See:

New in version 2.2.0.

INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_OVERRIDES#

A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry:

  • If true, ESS updates/overrides the baggage entry with the header value.

  • If false (the default), ESS keeps the baggage entry.

For details, Duplicate Property Definition.

New in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW#

A comma-separated list of application-defined properties that can return as response headers (unless specified in the corresponding INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY).

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

See:

New in version 2.2.0.

INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY#

A comma-separated list of application-defined properties to exclude from returning as response headers. This setting takes precedence over INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW.

This configuration is case-sensitive to the propagated properties in the baggage.

Tip

To exclude a propagated property that was added via the INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW configuration, ensure that the cases of these properties match.

See:

New in version 2.2.0.

Additional Information#

See also https://quarkus.io/guides/all-config.