audit

package

Go to main page

Versions in this module

v0

v0.0.14

Jan 4, 2026

v0.0.13

Jan 3, 2026

v0.0.12

Jan 3, 2026

v0.0.11

Jan 3, 2026

v0.0.10

Jan 3, 2026

v0.0.9

Jan 3, 2026

Changes in this version

+ type ActionStatistic struct

+ Action string

+ Count int64

+ FirstOccurred time.Time

+ LastOccurred time.Time

+ type ActionUserStatistic struct

+ Action string

+ Count int64

+ UserID *xid.ID

+ type ActivitySummary struct

+ DailyBreakdown []*DayStatistic

+ Filter *StatisticsFilter

+ HourlyBreakdown []*HourStatistic

+ TopActions []*ActionStatistic

+ TopIPs []*IPStatistic

+ TopResources []*ResourceStatistic

+ TopUsers []*UserStatistic

+ TotalEvents int64

+ UniqueIPs int64

+ UniqueUsers int64

type Baseline

+ OrganizationID *xid.ID

type BaselineCalculator

+ func (bc *BaselineCalculator) CalculateWithOptions(ctx context.Context, userID xid.ID, period time.Duration, ...) (*Baseline, error)

+ type CountEventsRequest struct

+ Filter *ListEventsFilter

+ type CountEventsResponse struct

+ Count int64

type CreateEventRequest

+ OrganizationID *xid.ID

+ type DateStatistic struct

+ Count int64

+ Date string

+ type DayStatistic struct

+ Count int64

+ Day string

+ DayIndex int

+ type DeleteFilter struct

+ Action *string

+ AppID *xid.ID

+ EnvironmentID *xid.ID

+ MetadataFilters []MetadataFilter

+ OrganizationID *xid.ID

+ Resource *string

+ UserID *xid.ID

+ type DeleteOlderThanRequest struct

+ Before time.Time

+ Filter *DeleteFilter

+ type DeleteOlderThanResponse struct

+ DeletedCount int64

type Event

+ OrganizationID *xid.ID

+ type GetGrowthRateResponse struct

+ Filter *StatisticsFilter

+ Metrics *GrowthMetrics

+ type GetOldestEventRequest struct

+ Filter *ListEventsFilter

+ type GetOldestEventResponse struct

+ Event *Event

+ type GetStatisticsByActionAndUserResponse struct

+ Statistics []*ActionUserStatistic

+ Total int64

+ type GetStatisticsByActionRequest struct

+ Filter *StatisticsFilter

+ type GetStatisticsByActionResponse struct

+ Statistics []*ActionStatistic

+ Total int64

+ type GetStatisticsByDateResponse struct

+ Statistics []*DateStatistic

+ Total int64

+ type GetStatisticsByDayResponse struct

+ Statistics []*DayStatistic

+ Total int64

+ type GetStatisticsByHourResponse struct

+ Statistics []*HourStatistic

+ Total int64

+ type GetStatisticsByIPAddressResponse struct

+ Statistics []*IPStatistic

+ Total int64

+ type GetStatisticsByResourceAndActionResponse struct

+ Statistics []*ResourceActionStatistic

+ Total int64

+ type GetStatisticsByResourceRequest struct

+ Filter *StatisticsFilter

+ type GetStatisticsByResourceResponse struct

+ Statistics []*ResourceStatistic

+ Total int64

+ type GetStatisticsByUserRequest struct

+ Filter *StatisticsFilter

+ type GetStatisticsByUserResponse struct

+ Statistics []*UserStatistic

+ Total int64

+ type GetTimeSeriesResponse struct

+ Interval TimeSeriesInterval

+ Points []*TimeSeriesPoint

+ Total int64

+ type GetTrendsResponse struct

+ Actions *TrendData

+ Events *TrendData

+ Resources *TrendData

+ Users *TrendData

+ type GrowthMetrics struct

+ DailyGrowth float64

+ LastMonthCount int64

+ LastWeekCount int64

+ MonthlyGrowth float64

+ ThisMonthCount int64

+ ThisWeekCount int64

+ TodayCount int64

+ WeeklyGrowth float64

+ YesterdayCount int64

+ type HourStatistic struct

+ Count int64

+ Hour int

+ type IPStatistic struct

+ Count int64

+ FirstOccurred time.Time

+ IPAddress string

+ LastOccurred time.Time

type ListEventsFilter

+ AppID *xid.ID

+ AppIDs []xid.ID

+ OrganizationID *xid.ID

+ OrganizationIDs []xid.ID

type Repository

+ Count func(ctx context.Context, filter *ListEventsFilter) (int64, error)

+ DeleteOlderThan func(ctx context.Context, filter *DeleteFilter, before time.Time) (int64, error)

+ GetOldestEvent func(ctx context.Context, filter *ListEventsFilter) (*schema.AuditEvent, error)

+ GetStatisticsByAction func(ctx context.Context, filter *StatisticsFilter) ([]*ActionStatistic, error)

+ GetStatisticsByActionAndUser func(ctx context.Context, filter *StatisticsFilter) ([]*ActionUserStatistic, error)

+ GetStatisticsByDate func(ctx context.Context, filter *StatisticsFilter) ([]*DateStatistic, error)

+ GetStatisticsByDay func(ctx context.Context, filter *StatisticsFilter) ([]*DayStatistic, error)

+ GetStatisticsByHour func(ctx context.Context, filter *StatisticsFilter) ([]*HourStatistic, error)

+ GetStatisticsByIPAddress func(ctx context.Context, filter *StatisticsFilter) ([]*IPStatistic, error)

+ GetStatisticsByResource func(ctx context.Context, filter *StatisticsFilter) ([]*ResourceStatistic, error)

+ GetStatisticsByResourceAndAction func(ctx context.Context, filter *StatisticsFilter) ([]*ResourceActionStatistic, error)

+ GetStatisticsByUser func(ctx context.Context, filter *StatisticsFilter) ([]*UserStatistic, error)

+ GetTimeSeries func(ctx context.Context, filter *TimeSeriesFilter) ([]*TimeSeriesPoint, error)

+ GetUniqueIPCount func(ctx context.Context, filter *StatisticsFilter) (int64, error)

+ type ResourceActionStatistic struct

+ Action string

+ Count int64

+ Resource string

+ type ResourceStatistic struct

+ Count int64

+ FirstOccurred time.Time

+ LastOccurred time.Time

+ Resource string

type SearchQuery

+ OrganizationID *xid.ID

type SearchQueryBuilder

+ func (b *SearchQueryBuilder) ForEnvironment(envID xid.ID) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) ForOrganization(orgID xid.ID) *SearchQueryBuilder

type Service

+ func (s *Service) Count(ctx context.Context, filter *ListEventsFilter) (int64, error)

+ func (s *Service) CountEvents(ctx context.Context, filter *ListEventsFilter) (int64, error)

+ func (s *Service) DeleteOlderThan(ctx context.Context, filter *DeleteFilter, before time.Time) (int64, error)

+ func (s *Service) GetActivitySummary(ctx context.Context, filter *StatisticsFilter) (*ActivitySummary, error)

+ func (s *Service) GetGrowthRate(ctx context.Context, filter *StatisticsFilter) (*GetGrowthRateResponse, error)

+ func (s *Service) GetOldestEvent(ctx context.Context, filter *ListEventsFilter) (*Event, error)

+ func (s *Service) GetStatisticsByAction(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByActionResponse, error)

+ func (s *Service) GetStatisticsByActionAndUser(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByActionAndUserResponse, error)

+ func (s *Service) GetStatisticsByDate(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByDateResponse, error)

+ func (s *Service) GetStatisticsByDay(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByDayResponse, error)

+ func (s *Service) GetStatisticsByHour(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByHourResponse, error)

+ func (s *Service) GetStatisticsByIPAddress(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByIPAddressResponse, error)

+ func (s *Service) GetStatisticsByResource(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByResourceResponse, error)

+ func (s *Service) GetStatisticsByResourceAndAction(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByResourceAndActionResponse, error)

+ func (s *Service) GetStatisticsByUser(ctx context.Context, filter *StatisticsFilter) (*GetStatisticsByUserResponse, error)

+ func (s *Service) GetTimeSeries(ctx context.Context, filter *TimeSeriesFilter) (*GetTimeSeriesResponse, error)

+ func (s *Service) GetTrends(ctx context.Context, filter *TrendFilter) (*GetTrendsResponse, error)

+ func (s *Service) GetUniqueIPCount(ctx context.Context, filter *StatisticsFilter) (int64, error)

+ type StatisticsFilter struct

+ Action *string

+ AppID *xid.ID

+ EnvironmentID *xid.ID

+ Limit int

+ MetadataFilters []MetadataFilter

+ OrganizationID *xid.ID

+ Resource *string

+ Since *time.Time

+ Until *time.Time

+ UserID *xid.ID

+ type TimeSeriesFilter struct

+ Interval TimeSeriesInterval

+ type TimeSeriesInterval string

+ const IntervalDaily

+ const IntervalHourly

+ const IntervalMonthly

+ const IntervalWeekly

+ type TimeSeriesPoint struct

+ Count int64

+ Timestamp time.Time

+ type TrendData struct

+ ChangeAbsolute int64

+ ChangeDirection string

+ ChangePercent float64

+ CurrentPeriod int64

+ PreviousPeriod int64

+ type TrendFilter struct

+ PeriodDuration time.Duration

+ type UserStatistic struct

+ Count int64

+ FirstOccurred time.Time

+ LastOccurred time.Time

+ UserID *xid.ID

v0.0.8

Dec 31, 2025

Changes in this version

type CreateEventRequest

+ EnvironmentID *xid.ID

type Event

+ EnvironmentID *xid.ID

type ListEventsFilter

+ ActionPattern *string

+ Actions []string

+ EnvironmentID *xid.ID

+ IPAddresses []string

+ IPRange *string

+ MetadataFilters []MetadataFilter

+ ResourcePattern *string

+ Resources []string

+ SearchFields []string

+ SearchQuery *string

+ UserIDs []xid.ID

+ type MetadataFilter struct

+ Key string

+ Operator string

+ Value interface{}

type SearchQuery

+ EnvironmentID *xid.ID

v0.0.7

Dec 29, 2025

Changes in this version

+ type AnalyticsService struct

+ func NewAnalyticsService(repo Repository) *AnalyticsService

+ type Anomaly struct

+ Baseline *Baseline

+ Description string

+ DetectedAt time.Time

+ Event *Event

+ Evidence map[string]interface{}

+ Score float64

+ Severity string

+ Type string

+ type AnomalyDetector struct

+ func NewAnomalyDetector() *AnomalyDetector

+ func (ad *AnomalyDetector) DetectAnomalies(ctx context.Context, event *Event, baseline *Baseline) ([]*Anomaly, error)

+ func (ad *AnomalyDetector) SetBaselineCalculator(calc *BaselineCalculator)

+ type AuditProvider interface

+ Healthy func(ctx context.Context) error

+ OnEvent func(ctx context.Context, event *Event) error

+ type Baseline struct

+ AvgSessionLength time.Duration

+ CalculatedAt time.Time

+ EventsPerHour float64

+ Metadata map[string]interface{}

+ Period time.Duration

+ TopActions map[string]int

+ TopLocations []string

+ TopResources map[string]int

+ TypicalDays []time.Weekday

+ TypicalHours []int

+ UniqueIPCount int

+ UserID xid.ID

+ type BaselineCache struct

+ func NewBaselineCache() *BaselineCache

+ func (bc *BaselineCache) Get(userID xid.ID) (*Baseline, bool)

+ func (bc *BaselineCache) Set(userID xid.ID, baseline *Baseline)

+ type BaselineCalculator struct

+ func NewBaselineCalculator(repo Repository) *BaselineCalculator

+ func (bc *BaselineCalculator) Calculate(ctx context.Context, userID xid.ID, period time.Duration) (*Baseline, error)

+ type ClientStats struct

+ BufferSize int

+ Connected time.Duration

+ ID string

+ type GenericOrganization struct

+ CreatedAt time.Time

+ DisplayName string

+ ID string

+ Members int

+ Metadata map[string]interface{}

+ Name string

+ ParentID *string

+ Status string

+ UpdatedAt time.Time

+ type GenericUser struct

+ CreatedAt time.Time

+ DisplayName string

+ Email string

+ FailedLoginCount int

+ Groups []string

+ ID string

+ LastLogin time.Time

+ LoginCount int

+ MFAEnabled bool

+ MFAMethods []string

+ Metadata map[string]interface{}

+ PasswordChanged time.Time

+ Roles []string

+ Status string

+ UpdatedAt time.Time

+ Username string

+ type GeoVelocityDetector struct

+ func (gvd *GeoVelocityDetector) DetectImpossibleTravel(event1, event2 *Event) (*Anomaly, error)

+ type MetricsQuery struct

+ EndDate *time.Time

+ Granularity string

+ GroupBy []string

+ Metrics []string

+ StartDate *time.Time

+ type OrgFilter struct

+ IDs []string

+ Limit int

+ Offset int

+ ParentID *string

+ Status *string

+ type OrganizationProvider interface

+ GetOrganization func(ctx context.Context, orgID string) (*GenericOrganization, error)

+ ListOrganizations func(ctx context.Context, filter *OrgFilter) ([]*GenericOrganization, error)

+ type PollingStreamService struct

+ func NewPollingStreamService(repo Repository) *PollingStreamService

+ func (s *PollingStreamService) Shutdown()

+ func (s *PollingStreamService) Subscribe(ctx context.Context, filter *StreamFilter) (<-chan *Event, string, error)

+ func (s *PollingStreamService) Unsubscribe(clientID string)

+ type ProviderRegistry struct

+ func NewProviderRegistry() *ProviderRegistry

+ func (r *ProviderRegistry) AddAuditProvider(provider AuditProvider)

+ func (r *ProviderRegistry) GetAuditProviders() []AuditProvider

+ func (r *ProviderRegistry) GetOrgProvider() OrganizationProvider

+ func (r *ProviderRegistry) GetUserProvider() UserProvider

+ func (r *ProviderRegistry) NotifyAuditEvent(ctx context.Context, event *Event)

+ func (r *ProviderRegistry) SetOrgProvider(provider OrganizationProvider)

+ func (r *ProviderRegistry) SetUserProvider(provider UserProvider)

+ type RiskEngine struct

+ func NewRiskEngine() *RiskEngine

+ func (re *RiskEngine) Calculate(ctx context.Context, event *Event, anomalies []*Anomaly, baseline *Baseline) (*RiskScore, error)

+ type RiskScore struct

+ Anomalies []*Anomaly

+ CalculatedAt time.Time

+ Event *Event

+ Factors map[string]float64

+ Level string

+ Score float64

+ type Scope struct

+ ID string

+ ParentID *string

+ Type ScopeType

+ type ScopeType string

+ const ScopeTypeApp

+ const ScopeTypeOrg

+ const ScopeTypeRole

+ const ScopeTypeSystem

+ const ScopeTypeTeam

+ const ScopeTypeUser

+ type SearchQuery struct

+ Action string

+ AppID *xid.ID

+ Fields []string

+ FuzzyMatch bool

+ Limit int

+ Offset int

+ Query string

+ Since *time.Time

+ Until *time.Time

+ UserID *xid.ID

+ type SearchQueryBuilder struct

+ func NewSearchQuery(searchText string) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Build() *SearchQuery

+ func (b *SearchQueryBuilder) ForApp(appID xid.ID) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) ForUser(userID xid.ID) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Fuzzy() *SearchQueryBuilder

+ func (b *SearchQueryBuilder) InFields(fields ...string) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Limit(limit int) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Offset(offset int) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Since(t time.Time) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) Until(t time.Time) *SearchQueryBuilder

+ func (b *SearchQueryBuilder) WithAction(action string) *SearchQueryBuilder

+ type SearchRepository interface

+ Search func(ctx context.Context, query *SearchQuery) (*SearchResponse, error)

+ SearchPostgreSQL func(ctx context.Context, query *SearchQuery) (*SearchResponse, error)

+ SearchSQLite func(ctx context.Context, query *SearchQuery) (*SearchResponse, error)

+ type SearchResponse struct

+ Pagination *pagination.PageMeta

+ Query string

+ Results []*SearchResult

+ TookMs int64

+ type SearchResult struct

+ Event *Event

+ Rank float64

type Service

+ func (s *Service) GetProviders() *ProviderRegistry

+ func (s *Service) Search(ctx context.Context, query *SearchQuery) (*SearchResponse, error)

+ type ServiceConfig struct

+ Providers *ProviderRegistry

+ type ServiceOption func(*ServiceConfig)

+ func WithAuditProvider(provider AuditProvider) ServiceOption

+ func WithOrgProvider(provider OrganizationProvider) ServiceOption

+ func WithProviders(providers *ProviderRegistry) ServiceOption

+ func WithUserProvider(provider UserProvider) ServiceOption

+ type StreamFilter struct

+ Actions []string

+ AppID *xid.ID

+ BufferSize int

+ UserID *xid.ID

+ type StreamService struct

+ func NewStreamService(listener interface{}) *StreamService

+ func (s *StreamService) Shutdown()

+ func (s *StreamService) Stats() StreamStats

+ func (s *StreamService) Subscribe(ctx context.Context, filter *StreamFilter) (<-chan *Event, string, error)

+ func (s *StreamService) Unsubscribe(clientID string)

+ func (s *StreamService) UpdateHeartbeat(clientID string)

+ type StreamStats struct

+ ActiveClients int

+ Clients []ClientStats

+ type UserFilter struct

+ CreatedAfter *time.Time

+ CreatedBefore *time.Time

+ Emails []string

+ IDs []string

+ LastLoginAfter *time.Time

+ LastLoginBefore *time.Time

+ Limit int

+ MFAEnabled *bool

+ Offset int

+ PasswordExpired *bool

+ PasswordExpiryAge *int

+ Roles []string

+ Status *string

+ type UserMetrics struct

+ ActiveUsers int

+ ByRole map[string]int

+ ByStatus map[string]int

+ CustomMetrics map[string]interface{}

+ ExpiredPasswords int

+ InactiveUsers int

+ LockedAccounts int

+ MFAAdoptionRate float64

+ SuspendedAccounts int

+ TotalUsers int

+ UsersWithMFA int

+ UsersWithoutMFA int

+ type UserProvider interface

+ GetUser func(ctx context.Context, scope *Scope, userID string) (*GenericUser, error)

+ ListUsers func(ctx context.Context, scope *Scope, filter *UserFilter) ([]*GenericUser, error)

+ QueryUserMetrics func(ctx context.Context, scope *Scope, query *MetricsQuery) (*UserMetrics, error)

v0.0.6

Dec 17, 2025

v0.0.5

Dec 12, 2025

v0.0.4

Dec 8, 2025

v0.0.3

Dec 8, 2025

v0.0.2

Nov 24, 2025

v0.0.1

Nov 20, 2025

Changes in this version

+ const CodeAuditEventCreateFailed

+ const CodeAuditEventNotFound

+ const CodeInvalidFilter

+ const CodeInvalidPagination

+ const CodeInvalidTimeRange

+ const CodeQueryFailed

+ func AuditEventCreateFailed(err error) *errs.AuthsomeError

+ func AuditEventNotFound(id string) *errs.AuthsomeError

+ func InvalidFilter(field, reason string) *errs.AuthsomeError

+ func InvalidPagination(reason string) *errs.AuthsomeError

+ func InvalidTimeRange(reason string) *errs.AuthsomeError

+ func QueryFailed(operation string, err error) *errs.AuthsomeError

+ type CreateEventRequest struct

+ Action string

+ AppID xid.ID

+ IPAddress string

+ Metadata string

+ Resource string

+ UserAgent string

+ UserID *xid.ID

+ type CreateEventResponse struct

+ Event *Event

+ type Event struct

+ Action string

+ AppID xid.ID

+ CreatedAt time.Time

+ ID xid.ID

+ IPAddress string

+ Metadata string

+ Resource string

+ UpdatedAt time.Time

+ UserAgent string

+ UserID *xid.ID

+ func FromSchemaEvent(ae *schema.AuditEvent) *Event

+ func FromSchemaEvents(events []*schema.AuditEvent) []*Event

+ func (e *Event) ToSchema() *schema.AuditEvent

+ type GetEventRequest struct

+ ID xid.ID

+ type GetEventResponse struct

+ Event *Event

+ type ListEventsFilter struct

+ Action *string

+ IPAddress *string

+ Resource *string

+ Since *time.Time

+ SortBy *string

+ SortOrder *string

+ Until *time.Time

+ UserID *xid.ID

+ type ListEventsResponse = pagination.PageResponse[*Event]

+ type Repository interface

+ Create func(ctx context.Context, e *schema.AuditEvent) error

+ Get func(ctx context.Context, id xid.ID) (*schema.AuditEvent, error)

+ List func(ctx context.Context, filter *ListEventsFilter) (*pagination.PageResponse[*schema.AuditEvent], error)

+ type Service struct

+ func NewService(repo Repository) *Service

+ func (s *Service) Create(ctx context.Context, req *CreateEventRequest) (*Event, error)

+ func (s *Service) Get(ctx context.Context, req *GetEventRequest) (*Event, error)

+ func (s *Service) List(ctx context.Context, filter *ListEventsFilter) (*ListEventsResponse, error)

+ func (s *Service) Log(ctx context.Context, userID *xid.ID, action, resource, ip, ua, metadata string) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL