apidump

type ApidumpError struct {
	// contains filtered or unexported fields
}

type Args struct {
	// Required args
	ClientID akid.ClientID
	Domain   string

	// If both LocalPath and AkitaURI are set, data is teed to both local traces
	// and backend trace.
	// If unset, defaults to a random spec name on Akita Cloud.
	Out location.Location

	// Args used to using agent with Postman
	PostmanCollectionID string

	// ServiceID parsed from projectID
	ServiceID akid.ServiceID

	Interfaces     []string
	Filter         string
	Tags           map[tags.Key]string
	PathExclusions []string
	HostExclusions []string
	PathAllowlist  []string
	HostAllowlist  []string

	// Rate-limiting parameters -- only one should be set to a non-default value.
	SampleRate         float64
	WitnessesPerMinute float64

	// If set, apidump will run the command in a subshell and terminate
	// automatically when the subcommand terminates.
	//
	// apidump will pipe stdout and stderr from the command. If the command stops
	// with non-zero exit code, apidump will also exit with the same exit code.
	ExecCommand string

	// Username to run ExecCommand as. If not set, defaults to the current user.
	ExecCommandUser string

	Plugins []plugin.AkitaPlugin

	// How often to rotate learn sessions; set to zero to disable rotation.
	LearnSessionLifetime time.Duration

	// Print packet capture statistics after N seconds.
	StatsLogDelay int

	// Periodically report telemetry every N seconds thereafter
	TelemetryInterval int

	// Periodically poll /proc fs for agent resource usage every N seconds.
	ProcFSPollingInterval int

	// Whether to report TCP connections and TLS handshakes.
	CollectTCPAndTLSReports bool

	// Parse TLS handshake messages (even if not reported)
	// Invariant: this is true if CollectTCPAndTLSReports is true
	ParseTLSHandshakes bool

	// The maximum witness size to upload. Anything larger is dropped.
	MaxWitnessSize_bytes int

	// Whether to run the command with additional functionality to support the Docker Extension
	DockerExtensionMode bool
	// The port to be used by the Docker Extension for health checks
	HealthCheckPort int

	// Whether to enable repro mode and include request/response payloads when uploading witnesses.
	ReproMode bool
}

type Summary struct {
	// Indicates whether this summary includes information about packets that did
	// not meet the BPF filters specified by the user.
	CapturingNegation bool

	Interfaces      map[string]interfaceInfo
	NegationFilters map[string]string
	NumUserFilters  int

	// Values that change over the course of apidump are pointers.
	FilterSummary    *trace.PacketCounter
	PrefilterSummary *trace.PacketCounter
	NegationSummary  *trace.PacketCounter
}