drop_filters

README

Drop Filters

Compatible with Logz.io's drop filters API.

Drop filters provide a solution for filtering out logs before they are indexed in your account to help lower costs and reduce account volume. To create a new drop filter:

client, _ := drop_filters.New(apiToken, apiServerAddress)
dropFilter, err := client.CreateDropFilter(drop_filters.CreateDropFilter{
                    LogType: "some_type",
                    FieldConditions: []drop_filters.FieldConditionObject{{
                        FieldName: "some_field_name",
                        Value:     "some_value",
                    }},
                })

function	func name
activate drop filter	func (c *DropFiltersClient) ActivateDropFilter(dropFilterID string) (*DropFilter, error)
create drop filter	func (c *DropFiltersClient) CreateDropFilter(createDropFilter CreateDropFilter) (*DropFilter, error)
deactivate drop filter	func (c *DropFiltersClient) DeactivateDropFilter(dropFilterId string) (*DropFilter, error)
delete drop filter	func (c *DropFiltersClient) DeleteDropFilter(dropFilterId string) error
retrieve drop filters	func (c *DropFiltersClient) RetrieveDropFilters() ([]DropFilter, error)

Documentation

Index

• type CreateDropFilter
• type DropFilter
• type DropFiltersClient
  • func New(apiToken, baseUrl string) (*DropFiltersClient, error)
  • func (c *DropFiltersClient) ActivateDropFilter(dropFilterId string) (*DropFilter, error)
  • func (c *DropFiltersClient) CreateDropFilter(createDropFilter CreateDropFilter) (*DropFilter, error)
  • func (c *DropFiltersClient) DeactivateDropFilter(dropFilterId string) (*DropFilter, error)
  • func (c *DropFiltersClient) DeleteDropFilter(dropFilterId string) error
  • func (c *DropFiltersClient) RetrieveDropFilters() ([]DropFilter, error)
• type FieldConditionObject
• type FieldError
  • func (e FieldError) Error() string

Types

type CreateDropFilter

type CreateDropFilter struct {
	LogType         string                 `json:"logType,omitempty"`
	FieldConditions []FieldConditionObject `json:"fieldConditions"`
}

type DropFilter

type DropFilter struct {
	Id             string                 `json:"id"`
	Active         bool                   `json:"active"`
	LogType        string                 `json:"logType"`
	FieldCondition []FieldConditionObject `json:"fieldConditions"`
}

type DropFiltersClient

type DropFiltersClient struct {
	*client.Client
}

func New

func New(apiToken, baseUrl string) (*DropFiltersClient, error)

func (*DropFiltersClient) ActivateDropFilter

func (c *DropFiltersClient) ActivateDropFilter(dropFilterId string) (*DropFilter, error)

ActivateDropFilter activates drop filter by id, returns the activated drop filter or error if occurred

func (*DropFiltersClient) CreateDropFilter

func (c *DropFiltersClient) CreateDropFilter(createDropFilter CreateDropFilter) (*DropFilter, error)

CreateDropFilter creates a drop filter, returns the created drop filter if successful, an error otherwise

func (*DropFiltersClient) DeactivateDropFilter

func (c *DropFiltersClient) DeactivateDropFilter(dropFilterId string) (*DropFilter, error)

DeactivateDropFilter deactivates drop filter by id, returns the deactivated drop filter or error if occurred

func (*DropFiltersClient) DeleteDropFilter

func (c *DropFiltersClient) DeleteDropFilter(dropFilterId string) error

DeleteDropFilter deletes a drop filter, specified by its unique id, returns an error if a problem is encountered

func (*DropFiltersClient) RetrieveDropFilters

func (c *DropFiltersClient) RetrieveDropFilters() ([]DropFilter, error)

RetrieveDropFilters returns all the drop filters in an array associated with the account identified by the supplied API token, returns an error if any problem occurs during the API call

type FieldConditionObject

type FieldConditionObject struct {
	FieldName string      `json:"fieldName"`
	Value     interface{} `json:"value"`
}

type FieldError

type FieldError struct {
	Field   string
	Message string
}

func (FieldError) Error

func (e FieldError) Error() string