You are viewing documentation for version 0.5.0. View latest version

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

getQueueName #

open fun getQueueName( extMatchmakingKey: ExtMatchmakingKey ): String

Allows you to specify a concise name for your matchmaking queues when represented in logs and metrics. Called when sending metrics or logging an event for a matchmaking queue.

Note: if you return an excessively large (in the hundreds) unique number of queue names, you may overload and crash your otel collector.

Used by:

  • MatchmakingService (MatchmakingQueues, MatchableQueue)

Parameters #

extMatchmakingKey

There are separate queues for each distinct MatchmakingQueueKey.