Package dev.sympho.modular_commands.execute

Interface Metrics.Tag

All Known Implementing Classes:

Metrics.Tag.Caller, Metrics.Tag.Channel, Metrics.Tag.CommandId, Metrics.Tag.CommandInvocation, Metrics.Tag.Guild, Metrics.Tag.Type

Enclosing class:

Metrics

public static interface Metrics.Tag

Tags used in metrics.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	Metrics.Tag.Caller	The tag that indicates the user who invoked the command.
static final record	Metrics.Tag.Channel	The tag that indicates the channel that the command was called from.
static final record	Metrics.Tag.CommandId	The tag that indicates the command ID.
static final record	Metrics.Tag.CommandInvocation	The tag that indicates the command invocation.
static final record	Metrics.Tag.Guild	The tag that indicates the guild that the command was called from, if any.
static enum	Metrics.Tag.Type	The tag that indicates the command type.

Method Summary

Modifier and Type	Method	Description
default <T> Flux<T>	apply(Flux<T> flux)	Applies this tag to the given flux using Flux.tag(String, String).
default <T> Mono<T>	apply(Mono<T> mono)	Applies this tag to the given mono using Mono.tag(String, String).
String	key()	Retrieves the tag key.
String	value()	Retrieves the tag value.

Method Details

key

@Pure
String key()

Retrieves the tag key.

Returns:

The tag key.

value

@Pure
String value()

Retrieves the tag value.

Returns:

The tag value.

apply

@SideEffectFree
default <T> Mono<T> apply(Mono<T> mono)

Applies this tag to the given mono using Mono.tag(String, String).

Type Parameters:

T - The mono value type.

Parameters:

mono - The mono to apply the tag to.

Returns:

The mono with the tag applied.

apply

@SideEffectFree
default <T> Flux<T> apply(Flux<T> flux)

Applies this tag to the given flux using Flux.tag(String, String).

Type Parameters:

T - The flux value type.

Parameters:

flux - The flux to apply the tag to.

Returns:

The flux with the tag applied.