Skip to main content

An extension for the library that enables Prometheus metrics

Project description


pip install discord-ext-prometheus

Exposed Metrics

Name Documentation Labels
discord_connected Determines if the bot is connected to Discord None
discord_event_on_interaction Amount of interactions command
discord_event_on_command Amount of commands 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


  • on_interaction are application interactions such as slash commands
  • on_command are traditional message commands (usualy using the command prefix)

Grafana Dashboard


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

from discord.ext.prometheus import *

async def main():
	bot = commands.Bot(

	await bot.add_cog(PrometheusCog(bot))

	await bot.start('YOUR TOKEN')

Sample code with logging metrics

from discord.ext.prometheus import *
import logging


async def main():
	bot = commands.Bot(

	await bot.add_cog(PrometheusCog(bot))'Starting the bot')
	await bot.start('YOUR TOKEN')

	async def on_ready():'Logged in as {}#{bot.user.discriminator}')

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))

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

discord_ext_prometheus-0.0.3.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

discord_ext_prometheus-0.0.3-py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page