Documentation ¶
Index ¶
- Constants
- func GetGithubToken(secretsDir string) (string, error)
- type Plugin
- func (p *Plugin) Extract(req sdk.ExtractRequest, evt sdk.EventReader) error
- func (p *Plugin) Fields() []sdk.FieldEntry
- func (p *Plugin) Info() *plugins.Info
- func (p *Plugin) Init(cfg string) error
- func (p *Plugin) InitSchema() *sdk.SchemaInfo
- func (p *Plugin) Open(params string) (source.Instance, error)
- func (p *Plugin) OpenParams() ([]sdk.OpenParam, error)
- func (p *Plugin) String(evt sdk.EventReader) (string, error)
- type PluginConfig
- type PluginInstance
- type RepoInfo
Constants ¶
View Source
const ( PluginID uint32 = 8 PluginName = "github" PluginDescription = "Reads github webhook events, by listening on a socket or by reading events from disk" PluginContact = "github.com/falcosecurity/plugins" PluginVersion = "0.7.3" PluginEventSource = "github" ExtractEventSource = "github" )
Variables ¶
This section is empty.
Functions ¶
func GetGithubToken ¶
Types ¶
type Plugin ¶
type Plugin struct { plugins.BasePlugin // contains filtered or unexported fields }
Plugin represent the GithHub plugin
func (*Plugin) Extract ¶
func (p *Plugin) Extract(req sdk.ExtractRequest, evt sdk.EventReader) error
Extract a field value from an event.
func (*Plugin) Fields ¶
func (p *Plugin) Fields() []sdk.FieldEntry
Return the fields supported for extraction.
func (*Plugin) InitSchema ¶
func (p *Plugin) InitSchema() *sdk.SchemaInfo
type PluginConfig ¶
type PluginConfig struct { Token string `` /* 212-byte string literal not displayed */ WebsocketServerURL string `` /* 178-byte string literal not displayed */ SecretsDir string `` /* 409-byte string literal not displayed */ UseHTTPs bool `` /* 444-byte string literal not displayed */ UseAsync bool `` /* 153-byte string literal not displayed */ }
PluginConfig represents a configuration of the GitHub plugin
func (*PluginConfig) Reset ¶
func (p *PluginConfig) Reset()
Reset sets the configuration to its default values
type PluginInstance ¶
type PluginInstance struct { source.BaseInstance // contains filtered or unexported fields }
PluginInstance represents an opened instance of the plugin, which is returned by Open() and deinitialized during Close().
func (*PluginInstance) Close ¶
func (o *PluginInstance) Close()
Closing the event stream and deinitialize the open plugin instance.
func (*PluginInstance) NextBatch ¶
func (o *PluginInstance) NextBatch(pState sdk.PluginState, evts sdk.EventWriters) (int, error)
Produce and return a new batch of events.
Click to show internal directories.
Click to hide internal directories.