io.helidon.metrics.api.ScopingConfigBlueprint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-metrics-api Show documentation

Loader for metrics implementation and a no-op implementation

There is a newer version: 4.1.4

/*
 * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
 *
 * 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.helidon.metrics.api;

import java.util.Map;
import java.util.Optional;

import io.helidon.builder.api.Option;
import io.helidon.builder.api.Prototype;

@Prototype.Configured
@Prototype.Blueprint
interface ScopingConfigBlueprint {

    /**
     * Default tag name for recording a meter's scope as a tag.
     */
    String SCOPE_TAG_NAME_DEFAULT = "scope";

    /**
     * Default scope value to associate with meters that are registered without an explicit setting; no setting means meters
     * are assigned scope {@value io.helidon.metrics.api.Meter.Scope#DEFAULT}.
     *
     * @return default scope value
     */
    @Option.Configured("default")
    @Option.Default(Meter.Scope.DEFAULT)
    Optional defaultValue();

    /**
     * Tag name for storing meter scope values in the underlying implementation meter registry.
     *
     * @return tag name for storing scope values
     */
    @Option.Configured
    @Option.Default(SCOPE_TAG_NAME_DEFAULT)
    Optional tagName();

    /**
     * Settings for individual scopes.
     *
     * @return scope settings
     */
    @Option.Configured
    @Option.Singular
    Map scopes();
}