Interface ShardDebugResponse

Full shard debug snapshot (requires shard token).

interface ShardDebugResponse {
    app: string;
    centralUrl: string;
    channels: { id: number; name: string; userIds: string[] }[];
    clients: number;
    entitledUntil: string;
    guildId: string;
    guildName: string;
    ok: boolean;
    publicUrl: string;
    runtime: string;
    startedAt: string;
    udpPublicHost?: string;
    udpVoice: Record<string, unknown>;
    udpVoiceEnabled: boolean;
    udpVoiceEndpoint: string;
    users: {
        assignedNetIds: number[];
        audioDropped: number;
        audioIn: number;
        audioOut: number;
        backpressureEvents: number;
        connectedAt: string;
        control: boolean;
        name: string;
        udpAudioIn: number;
        udpAudioOut: number;
        udpVoice: boolean;
        userId: string;
        voice: boolean;
    }[];
}

Properties

app centralUrl channels clients entitledUntil guildId guildName ok publicUrl runtime startedAt udpPublicHost? udpVoice udpVoiceEnabled udpVoiceEndpoint users

Properties

app

app: string

Application identifier.

centralUrl

centralUrl: string

URL of the central coordination service.

channels

channels: { id: number; name: string; userIds: string[] }[]

Channels and their member user IDs.

Type declaration

  • id: number

    Channel ID.

  • name: string

    Channel name.

  • userIds: string[]

    IDs of users in the channel.

clients

clients: number

Number of currently connected clients.

entitledUntil

entitledUntil: string

ISO timestamp until which the shard is entitled to run.

guildId

guildId: string

Discord guild ID this shard serves.

guildName

guildName: string

Human-readable guild name.

ok

ok: boolean

Whether the debug snapshot was produced successfully.

publicUrl

publicUrl: string

Public base URL of the shard.

runtime

runtime: string

Runtime environment description.

startedAt

startedAt: string

ISO timestamp when the shard started.

OptionaludpPublicHost

udpPublicHost?: string

Public host used for UDP voice, if any.

udpVoice

udpVoice: Record<string, unknown>

Raw UDP voice diagnostics.

udpVoiceEnabled

udpVoiceEnabled: boolean

Whether UDP voice transport is enabled.

udpVoiceEndpoint

udpVoiceEndpoint: string

UDP voice endpoint the shard advertises.

users

users: {
    assignedNetIds: number[];
    audioDropped: number;
    audioIn: number;
    audioOut: number;
    backpressureEvents: number;
    connectedAt: string;
    control: boolean;
    name: string;
    udpAudioIn: number;
    udpAudioOut: number;
    udpVoice: boolean;
    userId: string;
    voice: boolean;
}[]

Per-user connection and audio diagnostics.

Type declaration

  • assignedNetIds: number[]

    Net IDs currently assigned to the user.

  • audioDropped: number

    Count of dropped audio packets.

  • audioIn: number

    Inbound audio packet count.

  • audioOut: number

    Outbound audio packet count.

  • backpressureEvents: number

    Number of backpressure events observed.

  • connectedAt: string

    ISO timestamp when the user connected.

  • control: boolean

    Whether the user holds a control connection.

  • name: string

    Display name.

  • udpAudioIn: number

    Inbound UDP audio packet count.

  • udpAudioOut: number

    Outbound UDP audio packet count.

  • udpVoice: boolean

    Whether the user is using UDP voice transport.

  • userId: string

    User ID.

  • voice: boolean

    Whether the user has voice enabled.

Settings

Member Visibility

On This Page

Properties