Package jetbrains.buildServer.serverSide.statistics

Interface ValueType

All Superinterfaces:

ValueProvider

All Known Implementing Classes:

BuildAllTestsDurationValueType, BuildDurationValueType, BuildFinishAwareValueTypeBase, BuildValueTypeBase, CompositeVTB, DeclarativeCompositeValueType, MultipleKeysBuildMetricVT, ReusedBuildTimeValueType, RunningDetachedTimeValueType, SimpleBuildMetricVT, SuccessRateValueType, TestCountValueType, TestDurationValueType, TestMetadataValueType, TimeToFixValueType

public interface ValueType
extends ValueProvider

Statistic value type - such value type can be shown as a separate graph in the UI.

Method Summary

Modifier and Type	Method	Description
String	getDescription(ChartSettings chartSettings)	Metric textual description, i.e.
String	getExtendedDescription(ChartSettings chartSettings)	Extended metric textual description (for tooltip), i.e.
String	getSeriesColor(String s)	Allows to provide special color coding for series.
String	getSeriesGenericName()	Generic name for this value's series
String	getValueFormat()	Format name for Values (point hints and axis).
default String	getValueFormat(ChartSettings chartSettings)	Return format type for the values, according to provided chartSettings.

Methods inherited from interface jetbrains.buildServer.serverSide.statistics.ValueProvider

getDataSet, getKey, hasData

Method Detail

getDescription

@NotNull
String getDescription(ChartSettings chartSettings)

Metric textual description, i.e. "Build Duration"

Parameters:

chartSettings - the same settings as passed to ValueProvider.getDataSet(ChartSettings) method

Returns:

graph description, used in graph title on the web

getExtendedDescription

@NotNull
String getExtendedDescription(ChartSettings chartSettings)

Extended metric textual description (for tooltip), i.e. "Build Duration (includes stages A, B, C)"

Parameters:

chartSettings - the same filter as passed to ValueProvider.getDataSet(ChartSettings) method

Returns:

graph description, used in graph title on the web

getValueFormat

@Nullable
String getValueFormat()

Format name for Values (point hints and axis).

Following formats are supported by default:

• text - no special formatting, value is treat as float
• integer - only integer values
• duration - value is treat as milliseconds and is formatted
• size - value is treat as bytes and is formatted
• percent - value is treat as N%
• percentBy1 - value is treat as (N * 100)%

Returns:

format name.

getValueFormat

@Nullable
default String getValueFormat(@NotNull
                              ChartSettings chartSettings)

Return format type for the values, according to provided chartSettings. By default, delegates to getValueFormat()

Format name for Values (point hints and axis).

Following formats are supported by default:

• text - no special formatting, value is treat as float
• integer - only integer values
• duration - value is treat as milliseconds and is formatted
• size - value is treat as bytes and is formatted
• percent - value is treat as N%
• percentBy1 - value is treat as (N * 100)%

Parameters:

chartSettings - context which can be used to determine the format

Returns:

see above

Since:

2023.11

getSeriesColor

@Nullable
String getSeriesColor(String s)

Allows to provide special color coding for series.

Color should be formatted as web color - hex "#rrggbb" (or short hex form "#rgb") or color name.

Parameters:

s - series key

Returns:

series color, null to autogenerate by renderer

getSeriesGenericName

String getSeriesGenericName()

Generic name for this value's series

Returns:

short name string