game-common / pragma.matchmaking / MatchmakingPlugin / getQueueName /

getQueueName #

abstract fun getQueueName(extMatchmakingKey: ExtMatchmakingKey): String

Specify a concise name for your matchmaking queues when represented in logs and metrics. Called when creating metrics or logging an event for a matchmaking queue.

If two different queues evaluate to the same queue name, they will not properly report in the metrics. Only one of the conflicting metrics will be reported at a time.

WARNING: If you have a large unique number of queue names, you will overload and crash your otel collector. Consider limiting the output of this function (and, consequentially, the number of unique queues you have) to a set of under ten values.

Used by:

  • MatchmakingService (MatchmakingQueues, MatchableQueue)

Parameters #

extMatchmakingKey

There are separate queues for each distinct MatchmakingQueueKey.