Annotation Type TelemetryFormat


  • public @interface TelemetryFormat
    Display options for a Telemetry annotation. This annotation is used by the Telemetry.format() parameter.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int scale
      A scaling factor for the telemetry.
      boolean stacked
      Determines whether multiple lines in a telemetry should be stacked into an area graph.
      TelemetryUnit value
      The unit of the recorded values.
    • Element Detail

      • value

        TelemetryUnit value
        The unit of the recorded values. By default, telemetries are unitless.
        Default:
        com.jprofiler.api.probe.embedded.telemetry.TelemetryUnit.PLAIN
      • scale

        int scale
        A scaling factor for the telemetry. In the UI recorded values will be multiplied with 10^-scale.

        In JProfiler, probe telemetry data is stored in 32-bit ints. So this is especially useful for telemetries that will show higher values than 2^31. For example, if you use the TelemetryUnit.BYTES you can return kB instead and set the scale to -3.

        This is also useful to show fractional values. For example, if you want to show a percentage with two decimal digits, the returned value should be the percentage times 100 and the scale parameter should be set to 2.

        Default:
        0
      • stacked

        boolean stacked
        Determines 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