| /* |
| * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved. |
| * Copyright (c) 2020, Datadog, Inc. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package jdk.jfr.internal; |
| |
| import java.lang.annotation.ElementType; |
| import java.lang.annotation.Inherited; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.annotation.Target; |
| |
| import jdk.jfr.MetadataDefinition; |
| |
| /** |
| * Event annotation, determines the event emission rate in events per time unit. |
| * |
| * This setting is only supported for JVM events. |
| * |
| * @since 16 |
| */ |
| @MetadataDefinition |
| @Target({ ElementType.TYPE }) |
| @Inherited |
| @Retention(RetentionPolicy.RUNTIME) |
| public @interface Throttle { |
| /** |
| * Settings name {@code "throttle"} for configuring an event emission rate in events per time unit. |
| */ |
| public final static String NAME = "throttle"; |
| public final static String DEFAULT = "off"; |
| |
| /** |
| * Throttle, for example {@code "100/s"}. |
| * <p> |
| * String representation of a non-negative {@code Long} value followed by a slash ("/") |
| * and one of the following units<br> |
| * {@code "ns"} (nanoseconds)<br> |
| * {@code "us"} (microseconds)<br> |
| * {@code "ms"} (milliseconds)<br> |
| * {@code "s"} (seconds)<br> |
| * {@code "m"} (minutes)<br> |
| * {@code "h"} (hours)<br> |
| * {@code "d"} (days)<br> |
| * <p> |
| * Example values, {@code "6000/m"}, {@code "10/ms"} and {@code "200/s"}. |
| * When zero is specified, for example {@code "0/s"}, no events are emitted. |
| * When {@code "off"} is specified, all events are emitted. |
| * |
| * @return the throttle value, default {@code "off"} not {@code null} |
| * |
| */ |
| String value() default DEFAULT; |
| } |