auditing

Documentation

Index

• type Bucket
• type Client
• type Event
• type Events
• type Filter
• type Histogram
• type Options
  • func NewAuditingOptions() *Options
  • func (s *Options) AddFlags(fs *pflag.FlagSet, c *Options)
  • func (s *Options) ApplyTo(options *Options)
  • func (s *Options) Validate() []error
• type Statistics

Types

type Bucket

type Bucket struct {
	Time  int64 `json:"time" description:"timestamp"`
	Count int64 `json:"count" description:"total number of events at intervals"`
}

type Client

type Client interface {
	SearchAuditingEvent(filter *Filter, from, size int64, sort string) (*Events, error)
	CountOverTime(filter *Filter, interval string) (*Histogram, error)
	StatisticsOnResources(filter *Filter) (*Statistics, error)
}

type Event

type Event map[string]interface{}

type Events

type Events struct {
	Total   int64         `json:"total" description:"total number of matched results"`
	Records []interface{} `json:"records" description:"actual array of results"`
}

type Filter

type Filter struct {
	ObjectRefNamespaceMap   map[string]time.Time
	WorkspaceMap            map[string]time.Time
	ObjectRefNamespaces     []string
	ObjectRefNamespaceFuzzy []string
	Workspaces              []string
	WorkspaceFuzzy          []string
	ObjectRefNames          []string
	ObjectRefNameFuzzy      []string
	Levels                  []string
	Verbs                   []string
	Users                   []string
	UserFuzzy               []string
	GroupFuzzy              []string
	SourceIpFuzzy           []string
	ObjectRefResources      []string
	ObjectRefSubresources   []string
	ResponseCodes           []int32
	ResponseStatus          []string
	StartTime               time.Time
	EndTime                 time.Time
}

type Histogram

type Histogram struct {
	Total   int64    `json:"total" description:"total number of events"`
	Buckets []Bucket `json:"buckets" description:"actual array of histogram results"`
}

type Options

type Options struct {
	Enable     bool   `json:"enable" yaml:"enable"`
	WebhookUrl string `json:"webhookUrl" yaml:"webhookUrl"`
	// The maximum concurrent senders which send auditing events to the auditing webhook.
	EventSendersNum int `json:"eventSendersNum" yaml:"eventSendersNum"`
	// The batch size of auditing events.
	EventBatchSize int `json:"eventBatchSize" yaml:"eventBatchSize"`
	// The batch interval of auditing events.
	EventBatchInterval time.Duration `json:"eventBatchInterval" yaml:"eventBatchInterval"`
	Host               string        `json:"host" yaml:"host"`
	BasicAuth          bool          `json:"basicAuth" yaml:"basicAuth"`
	Username           string        `json:"username" yaml:"username"`
	Password           string        `json:"password" yaml:"password"`
	IndexPrefix        string        `json:"indexPrefix,omitempty" yaml:"indexPrefix,omitempty"`
	Version            string        `json:"version" yaml:"version"`
}

func NewAuditingOptions

func NewAuditingOptions() *Options

func (*Options) AddFlags

func (s *Options) AddFlags(fs *pflag.FlagSet, c *Options)

func (*Options) ApplyTo

func (s *Options) ApplyTo(options *Options)

func (*Options) Validate

func (s *Options) Validate() []error

type Statistics

type Statistics struct {
	Resources int64 `json:"resources" description:"total number of resources"`
	Events    int64 `json:"events" description:"total number of events"`
}