io.micrometer.observation.annotation.Observed Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micrometer-observation Show documentation

Module containing Observation related code

There is a newer version: 1.14.1

Show newest version

/*
 * Copyright 2022 VMware, Inc.
 *
 * 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
 *
 * https://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.micrometer.observation.annotation;

import java.lang.annotation.*;

/**
 * Annotated methods are instrumented using an
 * {@link io.micrometer.observation.Observation}.
 *
 * @author Jonatan Ivanov
 * @since 1.10.0
 * @see io.micrometer.observation.aop.ObservedAspect
 */
@Target({ ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface Observed {

    /**
     * Name of the {@link io.micrometer.observation.Observation}.
     * @return name of the {@link io.micrometer.observation.Observation}
     */
    String name() default "";

    /**
     * Contextual name of the {@link io.micrometer.observation.Observation}.
     * @return contextual name of the {@link io.micrometer.observation.Observation}
     */
    String contextualName() default "";

    /**
     * Low cardinality key values.
     * @return an array of low cardinality key values.
     */
    String[] lowCardinalityKeyValues() default {};

}