Package dev.sympho.modular_commands.execute

Interface InstrumentedContext

All Superinterfaces:

dev.sympho.bot_utils.access.AccessContext, dev.sympho.bot_utils.access.AccessValidator, dev.sympho.bot_utils.access.ChannelAccessContext, dev.sympho.bot_utils.access.ChannelAccessValidator, dev.sympho.bot_utils.event.ChannelEventContext, CommandContext, dev.sympho.bot_utils.event.EventContext, dev.sympho.bot_utils.event.RepliableContext

All Known Implementing Classes:

MessageContextImpl

public interface InstrumentedContext
extends CommandContext

A command context that is instrumented for use with metrics and tracing tooling.

Since:

1.0

Version:

1.0

API Note:

If also implementing LazyContext, this API should be available before any methods are called.

Method Summary

Modifier and Type	Method	Description
default <T> Mono<T>	addTags(Mono<T> mono)	Adds the common instrumentation tags for this context to a Mono.
String	getCommandId()	Retrieves the ID of the invoked command.
Metrics.Tag.Type	tagType()	Determines the value for the type tag.

Methods inherited from interface dev.sympho.bot_utils.access.AccessContext

asGuild, guild, guildId, isPrivate, user

Methods inherited from interface dev.sympho.bot_utils.access.ChannelAccessContext

asUser, channelId

Methods inherited from interface dev.sympho.bot_utils.event.ChannelEventContext

belongs, belongs, belongs, belongs, hasAccess, hasAccess, validate, validator

Methods inherited from interface dev.sympho.modular_commands.api.command.context.CommandContext

caller, callerMember, callerMember, channel, commandInvocation, getArgument, getArgument, getArgument, getContext, invocation, member, member, requireArgument, requireArgument, requireArgument, requireContext, setContext, setContext

Methods inherited from interface dev.sympho.bot_utils.event.EventContext

client, event, validate

Methods inherited from interface dev.sympho.bot_utils.event.RepliableContext

replies, reply, reply, reply, reply, reply, reply, reply

Method Details

getCommandId

@Pure
String getCommandId()

Retrieves the ID of the invoked command.

Returns:

The command ID.

tagType

@Pure
Metrics.Tag.Type tagType()

Determines the value for the type tag.

Returns:

The tag.

addTags

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

Adds the common instrumentation tags for this context to a Mono.

Type Parameters:

T - The mono value type.

Parameters:

mono - The mono to add tags to.

Returns:

The mono with tags added.