Documentation
¶
Overview ¶
Package splunk provides bounded, scoped Splunk search-job reads for native tools.
Index ¶
- Constants
- Variables
- type DiscoveryRequest
- type DiscoveryResult
- type ReadRequest
- type ReadResult
- type Record
- type Service
- func (service *Service) Discover(ctx context.Context, request DiscoveryRequest) (DiscoveryResult, error)
- func (service *Service) Read(ctx context.Context, request ReadRequest) (ReadResult, error)
- func (service *Service) ReadWindow(ctx context.Context, filters map[string]string, from, to time.Time, limit int, ...) (ReadResult, error)
- func (service *Service) ReadWindowWithFields(ctx context.Context, filters map[string]string, from, to time.Time, limit int, ...) (ReadResult, error)
- func (service *Service) ReadWindowWithStringFields(ctx context.Context, filters map[string]string, from, to time.Time, limit int, ...) (ReadResult, error)
Constants ¶
View Source
const MaximumLimit = 50
Variables ¶
View Source
var ErrCleanup = errors.New("splunk: job cleanup unconfirmed")
View Source
var ErrInvalidArgument = errors.New("splunk: invalid argument")
View Source
var ErrInvalidConfig = errors.New("splunk: invalid configuration")
View Source
var ErrRead = errors.New("splunk: read failed")
View Source
var ErrResponseTooLarge = errors.New("splunk: response too large")
View Source
var ErrUnsupportedScope = errors.New("splunk: configured search cannot be safely scoped")
Functions ¶
This section is empty.
Types ¶
type DiscoveryRequest ¶
type DiscoveryResult ¶
type ReadRequest ¶
type ReadResult ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) Discover ¶
func (service *Service) Discover(ctx context.Context, request DiscoveryRequest) (DiscoveryResult, error)
func (*Service) Read ¶
func (service *Service) Read(ctx context.Context, request ReadRequest) (ReadResult, error)
func (*Service) ReadWindow ¶ added in v1.4.32
func (*Service) ReadWindowWithFields ¶ added in v1.4.32
Click to show internal directories.
Click to hide internal directories.