EXPORTER_METRICS
constEXPORTER_METRICS:object
Defined in: packages/core/src/exporter.ts:30
The instruments every Shardlens exporter registers. Labels are bounded: command names, bucketed REST routes, statuses, shard numbers and custom event names you chose. There is no user or server label anywhere.
Type Declaration
Section titled “Type Declaration”cache_size
Section titled “cache_size”
readonlycache_size:object
cache_size.description
Section titled “cache_size.description”
readonlydescription:"discord.js cache sizes (users, channels)."='discord.js cache sizes (users, channels).'
cache_size.kind
Section titled “cache_size.kind”
readonlykind:"gauge"='gauge'
cache_size.labels
Section titled “cache_size.labels”
readonlylabels: readonly ["cache"]
cache_size.unit
Section titled “cache_size.unit”
readonlyunit:"1"='1'
custom_events
Section titled “custom_events”
readonlycustom_events:object
custom_events.description
Section titled “custom_events.description”
readonlydescription:"Custom events recorded with track(), by name."='Custom events recorded with track(), by name.'
custom_events.kind
Section titled “custom_events.kind”
readonlykind:"counter"='counter'
custom_events.labels
Section titled “custom_events.labels”
readonlylabels: readonly ["name"]
custom_events.unit
Section titled “custom_events.unit”
readonlyunit:"1"='1'
entitlements
Section titled “entitlements”
readonlyentitlements:object
entitlements.description
Section titled “entitlements.description”
readonlydescription:"Entitlement changes (create, update, delete)."='Entitlement changes (create, update, delete).'
entitlements.kind
Section titled “entitlements.kind”
readonlykind:"counter"='counter'
entitlements.labels
Section titled “entitlements.labels”
readonlylabels: readonly ["action"]
entitlements.unit
Section titled “entitlements.unit”
readonlyunit:"1"='1'
eventloop_delay_p99
Section titled “eventloop_delay_p99”
readonlyeventloop_delay_p99:object
eventloop_delay_p99.description
Section titled “eventloop_delay_p99.description”
readonlydescription:"Event loop delay, 99th percentile over the last 30 seconds."='Event loop delay, 99th percentile over the last 30 seconds.'
eventloop_delay_p99.kind
Section titled “eventloop_delay_p99.kind”
readonlykind:"gauge"='gauge'
eventloop_delay_p99.labels
Section titled “eventloop_delay_p99.labels”
readonlylabels: readonly [] =[]
eventloop_delay_p99.unit
Section titled “eventloop_delay_p99.unit”
readonlyunit:"seconds"='seconds'
guild_events
Section titled “guild_events”
readonlyguild_events:object
guild_events.description
Section titled “guild_events.description”
readonlydescription:"Servers joined and left, and outages (unavailable, available)."='Servers joined and left, and outages (unavailable, available).'
guild_events.kind
Section titled “guild_events.kind”
readonlykind:"counter"='counter'
guild_events.labels
Section titled “guild_events.labels”
readonlylabels: readonly ["event"]
guild_events.unit
Section titled “guild_events.unit”
readonlyunit:"1"='1'
guilds
Section titled “guilds”
readonlyguilds:object
guilds.description
Section titled “guilds.description”
readonlydescription:"Servers per shard."='Servers per shard.'
guilds.kind
Section titled “guilds.kind”
readonlykind:"gauge"='gauge'
guilds.labels
Section titled “guilds.labels”
readonlylabels: readonly ["shard"]
guilds.unit
Section titled “guilds.unit”
readonlyunit:"1"='1'
identify_remaining
Section titled “identify_remaining”
readonlyidentify_remaining:object
identify_remaining.description
Section titled “identify_remaining.description”
readonlydescription:"Gateway sessions left in Discord's daily identify budget."="Gateway sessions left in Discord's daily identify budget."
identify_remaining.kind
Section titled “identify_remaining.kind”
readonlykind:"gauge"='gauge'
identify_remaining.labels
Section titled “identify_remaining.labels”
readonlylabels: readonly [] =[]
identify_remaining.unit
Section titled “identify_remaining.unit”
readonlyunit:"1"='1'
interaction_errors
Section titled “interaction_errors”
readonlyinteraction_errors:object
interaction_errors.description
Section titled “interaction_errors.description”
readonlydescription:"Errors thrown by wrapped handlers, by error class (never the message)."='Errors thrown by wrapped handlers, by error class (never the message).'
interaction_errors.kind
Section titled “interaction_errors.kind”
readonlykind:"counter"='counter'
interaction_errors.labels
Section titled “interaction_errors.labels”
readonlylabels: readonly ["command","error_class"]
interaction_errors.unit
Section titled “interaction_errors.unit”
readonlyunit:"1"='1'
interaction_handler
Section titled “interaction_handler”
readonlyinteraction_handler:object
interaction_handler.description
Section titled “interaction_handler.description”
readonlydescription:"Time spent in a handler wrapped with lens.wrap(), or reported for a message command."='Time spent in a handler wrapped with lens.wrap(), or reported for a message command.'
interaction_handler.kind
Section titled “interaction_handler.kind”
readonlykind:"histogram"='histogram'
interaction_handler.labels
Section titled “interaction_handler.labels”
readonlylabels: readonly ["kind","command"]
interaction_handler.unit
Section titled “interaction_handler.unit”
readonlyunit:"seconds"='seconds'
interaction_response
Section titled “interaction_response”
readonlyinteraction_response:object
interaction_response.description
Section titled “interaction_response.description”
readonlydescription:"Time from Discord's interaction timestamp to the first response. Discord's deadline is 3 seconds."="Time from Discord's interaction timestamp to the first response. Discord's deadline is 3 seconds."
interaction_response.kind
Section titled “interaction_response.kind”
readonlykind:"histogram"='histogram'
interaction_response.labels
Section titled “interaction_response.labels”
readonlylabels: readonly ["kind","command"]
interaction_response.unit
Section titled “interaction_response.unit”
readonlyunit:"seconds"='seconds'
interactions
Section titled “interactions”
readonlyinteractions:object
interactions.description
Section titled “interactions.description”
readonlydescription:"Interactions handled (commands, context menus, components, modals, autocomplete) and message (prefix) commands, by outcome."='Interactions handled (commands, context menus, components, modals, autocomplete) and message (prefix) commands, by outcome.'
interactions.kind
Section titled “interactions.kind”
readonlykind:"counter"='counter'
interactions.labels
Section titled “interactions.labels”
readonlylabels: readonly ["kind","command","outcome"]
interactions.unit
Section titled “interactions.unit”
readonlyunit:"1"='1'
memory
Section titled “memory”
readonlymemory:object
memory.description
Section titled “memory.description”
readonlydescription:"Process memory (rss, heap_used)."='Process memory (rss, heap_used).'
memory.kind
Section titled “memory.kind”
readonlykind:"gauge"='gauge'
memory.labels
Section titled “memory.labels”
readonlylabels: readonly ["type"]
memory.unit
Section titled “memory.unit”
readonlyunit:"bytes"='bytes'
ratelimits
Section titled “ratelimits”
readonlyratelimits:object
ratelimits.description
Section titled “ratelimits.description”
readonlydescription:"Requests held back for a rate limit, by scope (user, global or shared)."='Requests held back for a rate limit, by scope (user, global or shared).'
ratelimits.kind
Section titled “ratelimits.kind”
readonlykind:"counter"='counter'
ratelimits.labels
Section titled “ratelimits.labels”
readonlylabels: readonly ["scope"]
ratelimits.unit
Section titled “ratelimits.unit”
readonlyunit:"1"='1'
rest_invalid_requests
Section titled “rest_invalid_requests”
readonlyrest_invalid_requests:object
rest_invalid_requests.description
Section titled “rest_invalid_requests.description”
readonlydescription:"Responses that count towards Discord's invalid-request limit (10,000 per 10 minutes per IP)."="Responses that count towards Discord's invalid-request limit (10,000 per 10 minutes per IP)."
rest_invalid_requests.kind
Section titled “rest_invalid_requests.kind”
readonlykind:"counter"='counter'
rest_invalid_requests.labels
Section titled “rest_invalid_requests.labels”
readonlylabels: readonly ["status"]
rest_invalid_requests.unit
Section titled “rest_invalid_requests.unit”
readonlyunit:"1"='1'
rest_requests
Section titled “rest_requests”
readonlyrest_requests:object
rest_requests.description
Section titled “rest_requests.description”
readonlydescription:"REST requests to Discord, by method, bucketed route and status."='REST requests to Discord, by method, bucketed route and status.'
rest_requests.kind
Section titled “rest_requests.kind”
readonlykind:"counter"='counter'
rest_requests.labels
Section titled “rest_requests.labels”
readonlylabels: readonly ["method","route","status"]
rest_requests.unit
Section titled “rest_requests.unit”
readonlyunit:"1"='1'
shard_events
Section titled “shard_events”
readonlyshard_events:object
shard_events.description
Section titled “shard_events.description”
readonlydescription:"Shard state changes (ready, resumed, reconnecting, disconnected, error, invalidated)."='Shard state changes (ready, resumed, reconnecting, disconnected, error, invalidated).'
shard_events.kind
Section titled “shard_events.kind”
readonlykind:"counter"='counter'
shard_events.labels
Section titled “shard_events.labels”
readonlylabels: readonly ["shard","state"]
shard_events.unit
Section titled “shard_events.unit”
readonlyunit:"1"='1'
shard_ping
Section titled “shard_ping”
readonlyshard_ping:object
shard_ping.description
Section titled “shard_ping.description”
readonlydescription:"Gateway heartbeat latency per shard."='Gateway heartbeat latency per shard.'
shard_ping.kind
Section titled “shard_ping.kind”
readonlykind:"gauge"='gauge'
shard_ping.labels
Section titled “shard_ping.labels”
readonlylabels: readonly ["shard"]
shard_ping.unit
Section titled “shard_ping.unit”
readonlyunit:"seconds"='seconds'