serverstats

README

Server stats plugin for YAGPDB

Records and shows stats for individual servers.

Current stats

Simple temporary stats:

• Messages last hour
• Users joined/left today
• Messages today, per channel with bar graphs
• Current online users
• Total amount of users

Planned soon

More peristent graphable stats:

• Users joined/left day to day chart
• Avg. users online day to day
• Messages day to day per channel

Redis layout

To count 24h stats yagpdb stores things inside sorted sets with unix timestamp as score, it will then routinely walk over all stats and remove those with screos of less then current unix time - 24h, this might be expensive later on, if so i might have to figure out a better way.

guild_stats_msg_channel:{guildid} - sorted set: key: channelid:msg_id, score: unix timestamp guild_stats_members_changed:{guildid} - sorted set: key: joined|left:userid, score: unix timestamp

Documentation

Index

• Variables
• func ApplyPresences(client *redis.Client, guildID int64, presences []*discordgo.Presence) error
• func Dir(useLocal bool, name string) http.FileSystem
• func FS(useLocal bool) http.FileSystem
• func FSByte(useLocal bool, name string) ([]byte, error)
• func FSMustByte(useLocal bool, name string) []byte
• func FSMustString(useLocal bool, name string) string
• func FSString(useLocal bool, name string) (string, error)
• func GetChannelMessageStats(client *redis.Client, raw []string, guildID int64) (map[string]*ChannelStats, error)
• func HandleGuildCreate(evt *eventsystem.EventData)
• func HandleMemberAdd(evt *eventsystem.EventData)
• func HandleMemberRemove(evt *eventsystem.EventData)
• func HandleMessageCreate(evt *eventsystem.EventData)
• func HandlePresenceUpdate(evt *eventsystem.EventData)
• func HandleReady(evt *eventsystem.EventData)
• func HandleStatsHtml(w http.ResponseWriter, r *http.Request, isPublicAccess bool) (web.TemplateData, error)
• func HandleStatsJson(w http.ResponseWriter, r *http.Request, isPublicAccess bool) interface{}
• func HandleStatsSettings(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func MarkGuildAsToBeChecked(guildID int64)
• func ProcessTempStats(full bool)
• func RegisterPlugin()
• func UpdateGuildStats(client *redis.Client, guildID int64) error
• func UpdateOldStats()
• func UpdateStatsLoop()
• type ChannelStats
• type FormData
• type FullStats
  • func RetrieveFullStats(client *redis.Client, guildID int64) (*FullStats, error)
  • func RetrieveRedisStats(client *redis.Client, guildID int64) (*FullStats, error)
• type Plugin
  • func (p *Plugin) InitBot()
  • func (p *Plugin) InitWeb()
  • func (p *Plugin) Name() string
  • func (p *Plugin) StartBot()
• type ServerStatsConfig
  • func GetConfig(ctx context.Context, GuildID int64) (*ServerStatsConfig, error)
  • func (c *ServerStatsConfig) GetName() string
  • func (s *ServerStatsConfig) PostFetch()

Variables

var (
	ServerStatsPeriodStore *models.StatsPeriodStore
)

Functions

func ApplyPresences

func ApplyPresences(client *redis.Client, guildID int64, presences []*discordgo.Presence) error

func Dir

func Dir(useLocal bool, name string) http.FileSystem

Dir returns a http.Filesystem for the embedded assets on a given prefix dir. If useLocal is true, the filesystem's contents are instead used.

func FS

func FS(useLocal bool) http.FileSystem

FS returns a http.Filesystem for the embedded assets. If useLocal is true, the filesystem's contents are instead used.

func FSByte

func FSByte(useLocal bool, name string) ([]byte, error)

FSByte returns the named file from the embedded assets. If useLocal is true, the filesystem's contents are instead used.

func FSMustByte

func FSMustByte(useLocal bool, name string) []byte

FSMustByte is the same as FSByte, but panics if name is not present.

func FSMustString

func FSMustString(useLocal bool, name string) string

FSMustString is the string version of FSMustByte.

func FSString

func FSString(useLocal bool, name string) (string, error)

FSString is the string version of FSByte.

func GetChannelMessageStats

func GetChannelMessageStats(client *redis.Client, raw []string, guildID int64) (map[string]*ChannelStats, error)

func HandleGuildCreate

func HandleGuildCreate(evt *eventsystem.EventData)

func HandleMemberAdd

func HandleMemberAdd(evt *eventsystem.EventData)

func HandleMemberRemove

func HandleMemberRemove(evt *eventsystem.EventData)

func HandleMessageCreate

func HandleMessageCreate(evt *eventsystem.EventData)

func HandlePresenceUpdate

func HandlePresenceUpdate(evt *eventsystem.EventData)

func HandleReady

func HandleReady(evt *eventsystem.EventData)

func HandleStatsHtml

func HandleStatsHtml(w http.ResponseWriter, r *http.Request, isPublicAccess bool) (web.TemplateData, error)

Somewhat dirty - should clean up this mess sometime

func HandleStatsJson

func HandleStatsJson(w http.ResponseWriter, r *http.Request, isPublicAccess bool) interface{}

func HandleStatsSettings

func HandleStatsSettings(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)

func MarkGuildAsToBeChecked

func MarkGuildAsToBeChecked(guildID int64)

func ProcessTempStats

func ProcessTempStats(full bool)

ProcessTempStats moves stats from redis to postgres batched up

func RegisterPlugin

func RegisterPlugin()

func UpdateGuildStats

func UpdateGuildStats(client *redis.Client, guildID int64) error

Updates the stats on a specific guild, removing expired stats

func UpdateOldStats

func UpdateOldStats()

func UpdateStatsLoop

func UpdateStatsLoop()

Types

type ChannelStats

type ChannelStats struct {
	Name  string `json:"name"`
	Count int64  `json:"count"`
}

type FormData

type FormData struct {
	Public         bool
	IgnoreChannels []string `valid:"channel,false"`
}

type FullStats

type FullStats struct {
	ChannelsHour map[string]*ChannelStats `json:"channels_hour"`
	JoinedDay    int                      `json:"joined_day"`
	LeftDay      int                      `json:"left_day"`
	Online       int                      `json:"online_now"`
	TotalMembers int                      `json:"total_members_now"`
}

func RetrieveFullStats

func RetrieveFullStats(client *redis.Client, guildID int64) (*FullStats, error)

func RetrieveRedisStats

func RetrieveRedisStats(client *redis.Client, guildID int64) (*FullStats, error)

type Plugin

type Plugin struct{}

func (*Plugin) InitBot

func (p *Plugin) InitBot()

func (*Plugin) InitWeb

func (p *Plugin) InitWeb()

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) StartBot

func (p *Plugin) StartBot()

type ServerStatsConfig

type ServerStatsConfig struct {
	configstore.GuildConfigModel
	Public         bool
	IgnoreChannels string

	ParsedChannels []string `gorm:"-"`
}

func GetConfig

func GetConfig(ctx context.Context, GuildID int64) (*ServerStatsConfig, error)

func (*ServerStatsConfig) GetName

func (c *ServerStatsConfig) GetName() string

func (*ServerStatsConfig) PostFetch

func (s *ServerStatsConfig) PostFetch()