Package org.apache.polaris.service.quarkus.metrics

Interface QuarkusMetricsConfiguration.RealmIdTag

Enclosing interface:
QuarkusMetricsConfiguration
public static interface QuarkusMetricsConfiguration.RealmIdTag

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    enableInApiMetrics()
    Whether to include the Realm ID tag in the API request metrics.
    boolean
    enableInHttpMetrics()
    Whether to include the Realm ID tag in the HTTP server request metrics.
    @jakarta.validation.constraints.Min(1L) int
    httpMetricsMaxCardinality()
    The maximum number of Realm ID tag values allowed for the HTTP server request metrics.

  • Method Details

    • enableInApiMetrics

      @WithDefault("false") boolean enableInApiMetrics()
      Whether to include the Realm ID tag in the API request metrics.

      Beware that if the cardinality of this tag is too high, it can cause performance issues or even crash the server.

    • enableInHttpMetrics

      @WithDefault("false") boolean enableInHttpMetrics()
      Whether to include the Realm ID tag in the HTTP server request metrics.

      Beware that if the cardinality of this tag is too high, it can cause performance issues or even crash the server.

    • httpMetricsMaxCardinality

      @WithDefault("100") @Min(1L) @jakarta.validation.constraints.Min(1L) int httpMetricsMaxCardinality()
      The maximum number of Realm ID tag values allowed for the HTTP server request metrics.

      This is used to prevent the number of tags from growing indefinitely and causing performance issues or crashing the server.

      If the number of tags exceeds this value, a warning will be logged and no more HTTP server request metrics will be recorded.