You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docker run --restart=unless-stopped -p 9678:9678 -e PIE_IRC.SERVER=irc.example.com:6667 ghcr.io/dgl/ircd_exporter
Options
Server to connect to:
-irc.nick string
Nickname to use (default "promexp")
-irc.oper string
Username to use for /OPER (optional)
-irc.oper-password string
Password to use for /OPER (optional)
-irc.password string
Password to use when connecting to the server (optional)
-irc.server string
Server to connect to, host:port (default "localhost:6667")
Where to listen for /metrics requests:
-listen string
[host]:port to serve HTTP on, for metrics collection (default ":9678")
Stats to collect:
-stats.ignore string
Servers to ignore for stats (comma separated, e.g. some services servers
don't support the LUSERS command).
-stats.local-only
Only get stats from the local server. Default is to run /LINKS and
record the LUSERS output from them all.
-stats.nicks
List of nicknames to check for ISON status (comma separated).
-stats.timeout duration
How long to wait before for stats reply before considering a server
down. (default 9s)
Environment variables are also supported for all flags (prefix with PIE_ and
replace - with _), but useful for passwords in particular, e.g.:
PIE_IRC.OPER_PASSWORD. (Many servers need operator privileges to see full
information in /LINKS, some restrict remote commands, if you want the timings to
be accurate you need flood controls to not be applied, etc.
So making this an operator is recommended.)
If you don't want to make this an operator using --stats.local-only and
running one per IRC server is recommended. Note --stats.local-only only
reports the server it is directly connected to in metrics such as irc_up, etc.
However irc_distance includes all servers (based on /LINKS output), see
example.yaml for a way to use this metric usefully.
Metrics exported
# HELP irc_connected Is the exporter connected to the server?
# TYPE irc_connected gauge
irc_connected 1
# HELP irc_channels Number of channels created in the IRC network.
# TYPE irc_channels gauge
irc_channels 42
# HELP irc_distance Number of hops this server is in the IRC network from the server where the exporter is running.
# TYPE irc_distance gauge
irc_distance{server="local.example.org"} 0
irc_distance{server="remote.example.org"} 1
# HELP irc_latency_seconds Latency of the request to this server from where the exporter is running.
# TYPE irc_latency_seconds gauge
irc_latency_seconds{server="local.example.org"} 0.015440223
# HELP irc_up Was the last query of each server successful.
# TYPE irc_up gauge
irc_up{server="local.example.org"} 1
irc_up{server="remote.example.org"} 0
# HELP irc_users Number of users on this IRC server.
# TYPE irc_users gauge
irc_users{server="local.example.org"} 746
# HELP irc_ison Whether specified nicknames are online or not.
# TYPE irc_ison gauge
irc_ison{nick="fred"} 0
irc_ison{nick="nickserv"} 1
