Package org.elasticsearch.xpack.esql.expression.promql.function

Class PromqlFunctionDefinition

java.lang.Object

org.elasticsearch.xpack.esql.expression.promql.function.PromqlFunctionDefinition

public final class PromqlFunctionDefinition
extends Object

Function definition record for registration and metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromqlFunctionDefinition.Builder	A builder for PromqlFunctionDefinitions.
static enum	PromqlFunctionDefinition.CounterSupport	Describes whether a PromQL function supports counter metric types.
static interface	PromqlFunctionDefinition.DateTimeFunctionBuilder	Builds an ES|QL expression for a PromQL date/time extraction function (e.g.
static interface	PromqlFunctionDefinition.FunctionBuilder
static interface	PromqlFunctionDefinition.PromqlBinaryOptionalValueTransformation
static enum	PromqlFunctionDefinition.PromqlDocsVersion	Stack (versioned Elasticsearch) releases that PromQL function documentation can reference.
static final record	PromqlFunctionDefinition.PromqlFunctionArity	Represents the parameter count constraints for a PromQL function.
static final record	PromqlFunctionDefinition.PromqlParamInfo
static final record	PromqlFunctionDefinition.StackAvailability	A single stack availability entry for a function's docs badge: a lifecycle state and the release it applies from, for example preview 9.4 or ga 9.5.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COUNT_NOTE
static final String	COUNTER_RATE_BEHAVIOR	Shared extended-description fragment for the counter rate family (rate, irate, increase), set as each function's PromqlFunctionDefinition.Builder.extendedDescription so it appears only on the dedicated function page, not in the brief functions overview.
static final String	DOMAIN_PLUS_MINUS_ONE_NOTE
static final String	FIRST_LAST_NOTE
static final String	GAUGE_FAMILY_BEHAVIOR	Shared extended-description fragment for the gauge family (delta, idelta, deriv), set as each function's PromqlFunctionDefinition.Builder.extendedDescription so it appears only on the dedicated function page, not in the brief functions overview.
static final PromqlFunctionDefinition.PromqlParamInfo	INSTANT_VECTOR
static final PromqlFunctionDefinition.PromqlParamInfo	INSTANT_VECTOR_OPTIONAL
static final String	LOG_DOMAIN_NOTE
static final PromqlFunctionDefinition.PromqlParamInfo	MAX_SCALAR
static final PromqlFunctionDefinition.PromqlParamInfo	MIN_SCALAR
static final String	OVERFLOW_NOTE
static final PromqlFunctionDefinition.PromqlParamInfo	QUANTILE
static final String	QUANTILE_NOTE
static final PromqlFunctionDefinition.PromqlParamInfo	RANGE_VECTOR
static final String	RATE_INCREASE_NOTE	Difference note for rate and increase: unlike Prometheus, which extrapolates within each (overlapping) range window, Elasticsearch evaluates these over fixed time buckets and interpolates the counter value at interior bucket boundaries from the adjacent buckets' samples.
static final PromqlFunctionDefinition.PromqlParamInfo	SCALAR
static final List<PromqlFunctionDefinition.StackAvailability>	STACK_GA_9_5	Stack availability for PromQL functions first implemented (and generally available) in 9.5.
static final List<PromqlFunctionDefinition.StackAvailability>	STACK_PREVIEW_9_4_GA_9_5	Stack availability for PromQL functions that shipped as a preview in 9.4 and became generally available in 9.5.
static final PromqlFunctionDefinition.PromqlParamInfo	TO_NEAREST

Method Summary

Modifier and Type	Method	Description
PromqlFunctionDefinition.PromqlFunctionArity	arity()
PromqlFunctionDefinition.CounterSupport	counterSupport()
static PromqlFunctionDefinition.Builder	def()	Create a builder for a PromqlFunctionDefinition.
String	description()
String	differenceFromPrometheus()	The "Differences from Prometheus" note rendered in the generated function docs, or null when the function matches the Prometheus reference behavior.
PromqlFunctionDefinition.FunctionBuilder	esqlBuilder()
List<String>	examples()
String	extendedDescription()	Additional description detail rendered only on the function's own reference page (after the brief summary), not in the per-category functions overview.
FunctionType	functionType()
static PromqlFunctionDefinition.StackAvailability	ga(PromqlFunctionDefinition.PromqlDocsVersion version)	Convenience factory for a ga stack availability entry.
String	name()
List<PromqlFunctionDefinition.PromqlParamInfo>	params()
static PromqlFunctionDefinition.StackAvailability	preview(PromqlFunctionDefinition.PromqlDocsVersion version)	Convenience factory for a preview stack availability entry.
static Expression	quantileToPercentile(Source source, Expression phi)	Scales a PromQL quantile φ (in the range [0, 1]) to the percentile value (in the range [0, 100]) expected by the ES|QL PERCENTILE aggregation that PromQL quantile and quantile_over_time translate into.
List<PromqlFunctionDefinition.StackAvailability>	stack()	The stack availability entries rendered into this function's docs applies_to badge (for example preview 9.4, ga 9.5).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

RANGE_VECTOR

public static final PromqlFunctionDefinition.PromqlParamInfo RANGE_VECTOR

INSTANT_VECTOR

public static final PromqlFunctionDefinition.PromqlParamInfo INSTANT_VECTOR

INSTANT_VECTOR_OPTIONAL

public static final PromqlFunctionDefinition.PromqlParamInfo INSTANT_VECTOR_OPTIONAL

SCALAR

public static final PromqlFunctionDefinition.PromqlParamInfo SCALAR

QUANTILE

public static final PromqlFunctionDefinition.PromqlParamInfo QUANTILE

TO_NEAREST

public static final PromqlFunctionDefinition.PromqlParamInfo TO_NEAREST

MIN_SCALAR

public static final PromqlFunctionDefinition.PromqlParamInfo MIN_SCALAR

MAX_SCALAR

public static final PromqlFunctionDefinition.PromqlParamInfo MAX_SCALAR

COUNTER_RATE_BEHAVIOR

public static final String COUNTER_RATE_BEHAVIOR

Shared extended-description fragment for the counter rate family (rate, irate, increase), set as each function's PromqlFunctionDefinition.Builder.extendedDescription so it appears only on the dedicated function page, not in the brief functions overview. Documents Elasticsearch behavior that is consistent with Prometheus.

See Also:

• Constant Field Values

RATE_INCREASE_NOTE

public static final String RATE_INCREASE_NOTE

Difference note for rate and increase: unlike Prometheus, which extrapolates within each (overlapping) range window, Elasticsearch evaluates these over fixed time buckets and interpolates the counter value at interior bucket boundaries from the adjacent buckets' samples. See RateDoubleGroupingAggregatorFunction.

See Also:

• Constant Field Values

GAUGE_FAMILY_BEHAVIOR

public static final String GAUGE_FAMILY_BEHAVIOR

Shared extended-description fragment for the gauge family (delta, idelta, deriv), set as each function's PromqlFunctionDefinition.Builder.extendedDescription so it appears only on the dedicated function page, not in the brief functions overview. Documents the transparent to_gauge coercion, which matches Prometheus semantics and so is not a "Differences from Prometheus" note. (Native histogram support is covered by the page-level limitations note rather than repeated here.)

See Also:

• Constant Field Values

FIRST_LAST_NOTE

public static final String FIRST_LAST_NOTE

See Also:

• Constant Field Values

COUNT_NOTE

public static final String COUNT_NOTE

See Also:

• Constant Field Values

LOG_DOMAIN_NOTE

public static final String LOG_DOMAIN_NOTE

See Also:

• Constant Field Values

DOMAIN_PLUS_MINUS_ONE_NOTE

public static final String DOMAIN_PLUS_MINUS_ONE_NOTE

See Also:

• Constant Field Values

OVERFLOW_NOTE

public static final String OVERFLOW_NOTE

See Also:

• Constant Field Values

QUANTILE_NOTE

public static final String QUANTILE_NOTE

See Also:

• Constant Field Values

STACK_PREVIEW_9_4_GA_9_5

public static final List<PromqlFunctionDefinition.StackAvailability> STACK_PREVIEW_9_4_GA_9_5

Stack availability for PromQL functions that shipped as a preview in 9.4 and became generally available in 9.5.

STACK_GA_9_5

public static final List<PromqlFunctionDefinition.StackAvailability> STACK_GA_9_5

Stack availability for PromQL functions first implemented (and generally available) in 9.5.

Method Details

name

public String name()

functionType

public FunctionType functionType()

arity

public PromqlFunctionDefinition.PromqlFunctionArity arity()

esqlBuilder

public PromqlFunctionDefinition.FunctionBuilder esqlBuilder()

description

public String description()

extendedDescription

public String extendedDescription()

Additional description detail rendered only on the function's own reference page (after the brief summary), not in the per-category functions overview. Used to keep the overview summaries short while documenting fuller behavior on the dedicated page. null when the function has no extra detail.

params

public List<PromqlFunctionDefinition.PromqlParamInfo> params()

examples

public List<String> examples()

counterSupport

public PromqlFunctionDefinition.CounterSupport counterSupport()

differenceFromPrometheus

public String differenceFromPrometheus()

The "Differences from Prometheus" note rendered in the generated function docs, or null when the function matches the Prometheus reference behavior.

stack

public List<PromqlFunctionDefinition.StackAvailability> stack()

The stack availability entries rendered into this function's docs applies_to badge (for example preview 9.4, ga 9.5). Empty when the function has not declared its availability, which the docs generator treats as an error so every registered function must declare one.

toString

public String toString()

Overrides:

toString in class Object

preview

public static PromqlFunctionDefinition.StackAvailability preview(PromqlFunctionDefinition.PromqlDocsVersion version)

Convenience factory for a preview stack availability entry.

ga

public static PromqlFunctionDefinition.StackAvailability ga(PromqlFunctionDefinition.PromqlDocsVersion version)

Convenience factory for a ga stack availability entry.

quantileToPercentile

public static Expression quantileToPercentile(Source source,
 Expression phi)

Scales a PromQL quantile φ (in the range [0, 1]) to the percentile value (in the range [0, 100]) expected by the ES|QL PERCENTILE aggregation that PromQL quantile and quantile_over_time translate into. Without this scaling, e.g. quantile(1.0, x) would collapse to the 0.01th percentile (≈ the minimum) instead of returning the maximum.

def

public static PromqlFunctionDefinition.Builder def()

Create a builder for a PromqlFunctionDefinition.