Documentation
¶
Overview ¶
Package graylog provides bounded, scoped, read-only Graylog queries for native tools.
Index ¶
- Constants
- Variables
- type DiscoveryRequest
- type DiscoveryResult
- type Policy
- 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, request ReadRequest, from, to time.Time) (ReadResult, error)
Constants ¶
View Source
const MaximumLimit = 100
View Source
const MaximumOffset = 99
Variables ¶
View Source
var ErrInvalidArgument = errors.New("graylog: invalid argument")
View Source
var ErrInvalidConfig = errors.New("graylog: invalid configuration")
View Source
var ErrResponseTooLarge = errors.New("graylog: response too large")
View Source
var ErrUnsupportedScope = errors.New("graylog: configured query cannot be safely scoped")
Functions ¶
This section is empty.
Types ¶
type DiscoveryRequest ¶
type DiscoveryResult ¶
type Policy ¶
func ToolPolicy ¶
func ToolPolicy() Policy
type ReadRequest ¶
type ReadResult ¶
type ReadResult struct {
Records []Record `json:"records"`
Count int `json:"count"`
Offset int `json:"offset"`
Limit int `json:"limit"`
NextOffset int `json:"next_offset,omitempty"`
Partial bool `json:"partial,omitempty"`
Truncated bool `json:"truncated"`
Truncation []string `json:"truncation,omitempty"`
}
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)
Discover samples a bounded recent search; the absolute search API does not promise a complete field inventory for the configured query and stream.
func (*Service) Read ¶
func (service *Service) Read(ctx context.Context, request ReadRequest) (ReadResult, error)
func (*Service) ReadWindow ¶ added in v1.4.32
func (service *Service) ReadWindow(ctx context.Context, request ReadRequest, from, to time.Time) (ReadResult, error)
Click to show internal directories.
Click to hide internal directories.