APIdia Launch Partner
Top Description Fields Methods
jdk.jfr

public @Interface Throttle

extends Annotation
Annotations
@MetadataDefinition
@Target:TYPE
@Inherited
@Retention:RUNTIME
Imports
java.lang.annotation.ElementType, .Inherited, .Retention, .RetentionPolicy, .Target
Event annotation, specifies the maximum rate of events per time unit, (for example, "100/s").

If the event class annotated with Throttle is filtered by other settings, such as a jdk.jfr.Threshold or a user-defined setting, the throttling will happen after those settings have been applied.

Since
25

Field Summary

Modifier and TypeField and Description
public static final String
NAME

Setting name "throttle" for configuring throttled events.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the throttle value, default "off"
value()

The throttle rate, for example "100/s".

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Field Detail

NAMEback to summary
public static final String NAME

Setting name "throttle" for configuring throttled events.

Method Detail

valueback to summary
public String value()

The throttle rate, for example "100/s".

String representation of a non-negative long value followed by a forward slash ("/") and one of the following units:

  • "ns" (nanoseconds)
  • "us" (microseconds)
  • "ms" (milliseconds)
  • "s" (seconds)
  • "m" (minutes)
  • "h" (hours)
  • "d" (days)

Example values, "6000/m", "10/ms" and "200/s".

Specifying zero, for example "0/s", results in no events being emitted.

Specifying "off" (case-sensitive) results in all events being emitted.

Returns:String

the throttle value, default "off"