io.stargate.sgv2.api.common.config.MetricsConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sgv2-quarkus-common Show documentation

There is a newer version: 2.1.0-BETA-19

/*
 * Copyright The Stargate Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package io.stargate.sgv2.api.common.config;

import io.smallrye.config.ConfigMapping;
import io.smallrye.config.WithDefault;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import java.util.Map;

/** Extra, Stargate related configuration for the metrics. */
@ConfigMapping(prefix = "stargate.metrics")
public interface MetricsConfig {

  /** @return Global tags attached to each metric being recorded. */
  Map globalTags();

  /** @return Setup for the tenant request counting. */
  @NotNull
  @Valid
  TenantRequestCounterConfig tenantRequestCounter();

  interface TenantRequestCounterConfig {

    /** @return If tenant request counter is enabled. */
    @WithDefault("${stargate.multi-tenancy.enabled}")
    boolean enabled();

    /**
     * @return The metric name for the counter, defaults to http.server.requests.counter
     *     .
     */
    @NotBlank
    @WithDefault("http.server.requests.counter")
    String metricName();

    /** @return The tag key for tenant-id, defaults to tenant. */
    @NotBlank
    @WithDefault("tenant")
    String tenantTag();

    /** @return The tag key for error flag, defaults to error. */
    @NotBlank
    @WithDefault("error")
    String errorTag();

    /** @return The tag key for user-agent flag, defaults to user_agent. */
    @NotBlank
    @WithDefault("user_agent")
    String userAgentTag();

    /** @return If tenant counting metric should include the user agent information. */
    @WithDefault("false")
    boolean userAgentTagEnabled();

    /** @return The tag key for HTTP status flag, defaults to status. */
    @NotBlank
    @WithDefault("status")
    String statusTag();

    /** @return If tenant counting metric should include the HTTP status information. */
    @WithDefault("false")
    boolean statusTagEnabled();
  }
}