discord-ext-prometheus
This is a library that makes it easy to add prometheus metrics to your Python Discord bot.
Installation
pip install discord-ext-prometheusExposed Metrics
| Name | Documentation | Labels |
|---|---|---|
discord_connected |
Determines if the bot is connected to Discord | shard |
discord_latency |
Latency to Discord | shard |
discord_event_on_interaction |
Amount of interactions called by users |
shard, interaction, command
|
discord_event_on_command |
Amount of commands called by users |
shard, command
|
discord_stat_total_guilds |
Amount of guild this bot is a member of | None |
discord_stat_total_channels |
Amount of channels this bot is has access to | None |
discord_stat_total_users |
Amount of users this bot can see | None |
discord_stat_total_commands |
Amount of commands | None |
logging |
Log entries |
logger, level
|
Notes:
-
on_interactionare application interactions such as slash commands or modals -
on_commandare traditional message commands (usualy using the command prefix)
Grafana Dashboard
Available to import from Grafana dashboards
How to use
Once the cog is added to your bot, the Prometheus metric endpoint can be accessed
at localhost:8000/metrics.
Sample code with the Prometheus Cog
import asyncio
from discord import Intents
from discord.ext import commands
from discord.ext.prometheus import PrometheusCog
async def main():
bot = commands.Bot(
command_prefix='!',
intents=Intents.all(),
)
await bot.add_cog(PrometheusCog(bot))
await bot.start('YOUR TOKEN')
asyncio.run(main())Sample code with logging metrics
import asyncio
import logging
from discord import Intents
from discord.ext import commands
from discord.ext.prometheus import PrometheusCog, PrometheusLoggingHandler
logging.getLogger().addHandler(PrometheusLoggingHandler())
async def main():
bot = commands.Bot(
command_prefix='!',
intents=Intents.all(),
)
await bot.add_cog(PrometheusCog(bot))
@bot.listen()
async def on_ready():
logging.info(f'Logged in as {bot.user.name}#{bot.user.discriminator}')
logging.info('Starting the bot')
await bot.start('YOUR TOKEN')
asyncio.run(main())Change the Prometheus port
The default port is 8000 but can be changed while creating the cog.
await bot.add_cog(PrometheusCog(bot, port=7000))
