Package com.perfino.annotation
Annotation Interface TelemetryFormat
public @interface TelemetryFormat
Display options for a
Telemetry
annotation.
This annotation is used by the Telemetry.format()
parameter.-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionboolean
By default, telemetry values from multiple VMs are averaged, for example, in the columns of the "VMs" view or when you select a VM group for a telemetry in the "VM Data Views".int
A scaling factor for the telemetry.boolean
Determines whether multiple lines in a telemetry should be stacked into an area graph.The unit of the recorded values.
-
Element Details
-
value
Unit valueThe unit of the recorded values. By default, telemetries are unitless.- Default:
PLAIN
-
scale
int scaleA scaling factor for the telemetry. In the UI recorded values will be multiplied with10^-scale
. This can be useful to create fractional values from monitored integer values.For example, if you want to show a percentage with two decimal digits, the monitored value should be the percentage times 100 and the scale parameter should be set to
2
.- Default:
0
-
stacked
boolean stackedDetermines whether multiple lines in a telemetry should be stacked into an area graph. By default, multiple telemetry lines are not stacked. An example of a stacked graph is the "Heap usage" telemetry.- Default:
false
-
groupAverage
boolean groupAverageBy default, telemetry values from multiple VMs are averaged, for example, in the columns of the "VMs" view or when you select a VM group for a telemetry in the "VM Data Views". If you want to show sums instead, set this parameter totrue
.The desired parameter value depends on the semantics of the monitored value. For shared resources, you probably do not want to average values. For resources that exist on each machine, the sums from multiple machines may not make much sense. For example, you would sum the monitored connections to a common database, but average the monitored number of worker threads. Also, business numbers like the number of logged on users will usually be summed.
- Default:
true
-