root

package
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: BSD-3-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Brimcap = &charm.Spec{
	Name:  "brimcap",
	Usage: "brimcap [global options] command [options] [arguments...]",
	Short: "search, analyze and inspect pcap files",
	Long: `
The Brimcap command provides utilties for searching, analyzing, and inspecting
pcap files. Most users will be interested in the brimcap analyze command, which
will read a pcap stream or file into multiple pcap analyzer processes (defaults
to Zeek and Suricata) and emits the generated logs from these processes. Brimcap
is built on top of the flexible Zed system (https://github.com/brimdata/zed),
so the logs can be written into a variety of structured log formats.

Logs written as ZNG or ZSON can be searched with
zq (https://github.com/brimdata/zed/tree/main/cmd/zed#zq) or loaded into a
Zed lake (https://github.com/brimdata/zed/blob/main/docs/lake/README.md)
using zapi (https://github.com/brimdata/zed/tree/main/cmd/zed#zapi) for
viewing in the Zui desktop app (https://github.com/brimdata/zui).

Additionally logs can also be written as ndjson and then operated on using jq
(https://stedolan.github.io/jq/).

The brimcap index command can be used to index pcap files for
flow extraction via the brimcap search command.
`,
	New: New,
}
View Source
var LogJSON bool

Functions

func LogError added in v0.0.3

func LogError(err error) error

func New

func New(parent charm.Command, f *flag.FlagSet) (charm.Command, error)

Types

type Command

type Command struct {
	charm.Command
	// contains filtered or unexported fields
}

func (*Command) AddRunnersToPath

func (c *Command) AddRunnersToPath() error

func (*Command) Cleanup

func (c *Command) Cleanup()

func (*Command) Init

func (c *Command) Init(all ...cli.Initializer) (func(), error)

func (*Command) InitWithContext added in v0.0.4

func (c *Command) InitWithContext(all ...cli.Initializer) (context.Context, func(), error)

func (*Command) Run

func (c *Command) Run(args []string) error

type MsgError

type MsgError struct {
	Type  string `json:"type"`
	Error string `json:"error"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL