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

• Constants
• Variables
• func HandleGuildCreate(evt *eventsystem.EventData)
• func HandleMemberAdd(evt *eventsystem.EventData)
• func HandleMemberRemove(evt *eventsystem.EventData)
• func HandleMessageCreate(evt *eventsystem.EventData)
• func HandleSaveStatsSettings(w http.ResponseWriter, r *http.Request) (web.TemplateData, error)
• func HandleStatsCharts(w http.ResponseWriter, r *http.Request, isPublicAccess bool) interface{}
• 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 MarkGuildAsToBeChecked(guildID int64)
• func ProcessTempStats(full bool)
• func RedisKeyChannelMessages(guildID int64) string
• func RegisterPlugin()
• func RoundHour(t time.Time) time.Time
• func SetUpdateMemberStatsPeriod(guildID int64, memberIncr int, numMembers int)
• func UpdateGuildStats(guildID int64) error
• type CacheKey
• type ChannelStats
• type ChartResponse
  • func CacheGetCharts(guildID int64, days int) *ChartResponse
• type DailyStats
  • func RetrieveDailyStats(guildID int64) (*DailyStats, error)
  • func RetrieveRedisStats(guildID int64) (*DailyStats, error)
• type FormData
• type MemberChartDataPeriod
  • func RetrieveMemberChartStats(guildID int64, days int) ([]*MemberChartDataPeriod, error)
• type MessageChartDataPeriod
  • func RetrieveMessageChartData(guildID int64, days int) ([]*MessageChartDataPeriod, error)
• type Plugin
  • func (p *Plugin) AddCommands()
  • func (p *Plugin) BotInit()
  • func (p *Plugin) InitWeb()
  • func (p *Plugin) Name() string
  • func (p *Plugin) RunBackgroundWorker()
  • func (p *Plugin) RunCleanup()
  • func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)
  • func (p *Plugin) UpdateStatsLoop()
• type ServerStatsConfig
  • func BotCachedFetchGuildConfig(ctx context.Context, gs *dstate.GuildState) (*ServerStatsConfig, error)
  • func GetConfig(ctx context.Context, GuildID int64) (*ServerStatsConfig, error)
  • func (s *ServerStatsConfig) ParseChannels()

Constants

const DBSchema = `` /* 1116-byte string literal not displayed */

const (
	RedisKeyGuildMembersChanged = "servers_stats_guild_members_changed"
)

const (
	RedisKeyLastHourlyRan = "serverstats_last_hourly_worker_ran"
)

Variables

var WebStatsCache = rcache.New(cacheChartFetcher, time.Minute)

Functions

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 HandleSaveStatsSettings

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

func HandleStatsCharts

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

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 MarkGuildAsToBeChecked

func MarkGuildAsToBeChecked(guildID int64)

func ProcessTempStats

func ProcessTempStats(full bool)

ProcessTempStats moves stats from redis to postgres batched up

func RedisKeyChannelMessages

func RedisKeyChannelMessages(guildID int64) string

func RegisterPlugin

func RegisterPlugin()

func RoundHour

func RoundHour(t time.Time) time.Time

RoundHour rounds a time.Time down to the hour

func SetUpdateMemberStatsPeriod

func SetUpdateMemberStatsPeriod(guildID int64, memberIncr int, numMembers int)

func UpdateGuildStats

func UpdateGuildStats(guildID int64) error

Updates the stats on a specific guild, removing expired stats

Types

type CacheKey

type CacheKey int

const (
	CacheKeyConfig CacheKey = iota
)

type ChannelStats

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

type ChartResponse

type ChartResponse struct {
	Days        int                       `json:"days"`
	MemberData  []*MemberChartDataPeriod  `json:"member_chart_data"`
	MessageData []*MessageChartDataPeriod `json:"message_chart_data"`
}

func CacheGetCharts

func CacheGetCharts(guildID int64, days int) *ChartResponse

type DailyStats

type DailyStats struct {
	ChannelMessages map[string]*ChannelStats `json:"channels_messages"`
	JoinedDay       int                      `json:"joined_day"`
	LeftDay         int                      `json:"left_day"`
	Online          int                      `json:"online_now"`
	TotalMembers    int                      `json:"total_members_now"`
}

func RetrieveDailyStats

func RetrieveDailyStats(guildID int64) (*DailyStats, error)

func RetrieveRedisStats

func RetrieveRedisStats(guildID int64) (*DailyStats, error)

type FormData

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

type MemberChartDataPeriod

type MemberChartDataPeriod struct {
	T          time.Time `json:"t"`
	Joins      int       `json:"joins"`
	Leaves     int       `json:"leaves"`
	NumMembers int       `json:"num_members"`
	MaxOnline  int       `json:"max_online"`
}

func RetrieveMemberChartStats

func RetrieveMemberChartStats(guildID int64, days int) ([]*MemberChartDataPeriod, error)

type MessageChartDataPeriod

type MessageChartDataPeriod struct {
	T            time.Time `json:"t"`
	MessageCount int       `json:"message_count"`
}

func RetrieveMessageChartData

func RetrieveMessageChartData(guildID int64, days int) ([]*MessageChartDataPeriod, error)

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func (*Plugin) AddCommands

func (p *Plugin) AddCommands()

func (*Plugin) BotInit

func (p *Plugin) BotInit()

func (*Plugin) InitWeb

func (p *Plugin) InitWeb()

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) RunBackgroundWorker

func (p *Plugin) RunBackgroundWorker()

func (*Plugin) RunCleanup

func (p *Plugin) RunCleanup()

func (*Plugin) StopBackgroundWorker

func (p *Plugin) StopBackgroundWorker(wg *sync.WaitGroup)

func (*Plugin) UpdateStatsLoop

func (p *Plugin) UpdateStatsLoop()

type ServerStatsConfig

type ServerStatsConfig struct {
	Public         bool
	IgnoreChannels string

	ParsedChannels []int64
}

ServerStatsConfig represents a configuration for a server reason we dont reference the model directly is because i need to figure out a way to migrate them over to the new schema, painlessly.

func BotCachedFetchGuildConfig

func BotCachedFetchGuildConfig(ctx context.Context, gs *dstate.GuildState) (*ServerStatsConfig, error)

func GetConfig

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

func (*ServerStatsConfig) ParseChannels

func (s *ServerStatsConfig) ParseChannels()