All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.microprofile.metrics.annotation.Metric Maven / Gradle / Ivy

There is a newer version: 5.1.2
Show newest version
/*
 **********************************************************************
 * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
 *               2012 Ryan W Tenney ([email protected])
 *
 * See the NOTICES file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 **********************************************************************/
package org.eclipse.microprofile.metrics.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.eclipse.microprofile.metrics.MetricRegistry;
import org.eclipse.microprofile.metrics.MetricUnits;

import jakarta.enterprise.util.Nonbinding;

/**
 * An annotation requesting that a metric be injected or registered. The metric will be registered in the application
 * MetricRegistry.
 *
 * Given an injected field annotated with {@literal @}Metric like this:
 *
 * 
 * 
 *     {@literal @}Inject
 *     {@literal @}Metric(name="histogram")
 *     public Histogram histogram;
 * 
 * 
* * A meter of the field's type will be created and injected into managed objects. It will be up to the user to interact * with the metric. This annotation can be used on fields of type Meter, Timer, SimpleTimer, Counter, and Histogram. *

* This may also be used to register a metric. *

*/ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE}) public @interface Metric { /** * The name of the metric. * * @return The name of the metric. */ @Nonbinding String name() default ""; /** * The tags of the metric. * * @return The tags of the metric. Each {@code String} tag must be in the form of 'key=value'. If the input is empty * or does not contain a '=' sign, the entry is ignored. * * @see org.eclipse.microprofile.metrics.Metadata */ @Nonbinding String[] tags() default {}; /** * Denotes whether to use the absolute name or use the default given name relative to the annotated class. * * @return If {@code true}, use the given name as an absolute name. If {@code false} (default), use the given name * relative to the annotated class. */ @Nonbinding boolean absolute() default false; /** * The description of the metric. * * @return The description of the metric. * * @see org.eclipse.microprofile.metrics.Metadata */ @Nonbinding String description() default ""; /** * The unit of the metric. * * @return The unit of the metric. By default, the value is {@link MetricUnits#NONE}. * * @see org.eclipse.microprofile.metrics.Metadata * @see org.eclipse.microprofile.metrics.MetricUnits */ @Nonbinding String unit() default MetricUnits.NONE; /** * The scope that this metric belongs to. * * @return The scope this metric belongs to. By default, the value is {@link MetricRegistry#APPLICATION_SCOPE}. * */ @Nonbinding String scope() default MetricRegistry.APPLICATION_SCOPE; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy