Package io.quarkus.micrometer.runtime.config.runtime

Interface HttpServerConfig

@ConfigMapping(prefix="quarkus.micrometer.binder.http-server") @ConfigRoot(phase=RUN_TIME) public interface HttpServerConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<List<String>>
    ignorePatterns()
    Comma-separated list of regular expressions defining uri paths that should be ignored (not measured).
    Optional<List<String>>
    matchPatterns()
    Comma-separated list of regular expressions used to specify uri labels in http metrics.
    int
    maxUriTags()
    Maximum number of unique URI tag values allowed.
    boolean
    suppress4xxErrors()
    Suppress 4xx errors from metrics collection for unmatched templates.
    boolean
    suppressNonApplicationUris()
    Suppress non-application uris from metrics collection.

  • Method Details

    • matchPatterns

      Optional<List<String>> matchPatterns()
      Comma-separated list of regular expressions used to specify uri labels in http metrics. Vertx instrumentation will attempt to transform parameterized resource paths, `/item/123`, into a generic form, `/item/{id}`, to reduce the cardinality of uri label values. Patterns specified here will take precedence over those computed values. For example, if `/item/\\\\d+=/item/custom` or `/item/[0-9]+=/item/custom` is specified in this list, a request to a matching path (`/item/123`) will use the specified replacement value (`/item/custom`) as the value for the uri label. Note that backslashes must be double escaped as `\\\\`.

    • ignorePatterns

      Optional<List<String>> ignorePatterns()
      Comma-separated list of regular expressions defining uri paths that should be ignored (not measured).

    • suppressNonApplicationUris

      @WithDefault("true") boolean suppressNonApplicationUris()
      Suppress non-application uris from metrics collection. This will suppress all metrics for non-application endpoints using `${quarkus.http.root-path}/${quarkus.http.non-application-root-path}`. Suppressing non-application uris is enabled by default.

    • suppress4xxErrors

      @WithDefault("false") boolean suppress4xxErrors()
      Suppress 4xx errors from metrics collection for unmatched templates. This configuration exists to limit cardinality explosion from caller side error. Does not apply to 404 errors. Suppressing 4xx errors is disabled by default.

    • maxUriTags

      @WithDefault("100") int maxUriTags()
      Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter.