tshark

Documentation

Index

• Constants
• Variables
• type Error
• type Tshark
  • func (t *Tshark) Clone(namePrefix string) (instance.SidecarManager, error)
  • func (t *Tshark) Initialize(ctx context.Context, namePrefix string, sysDeps *system.SystemDependencies) error
  • func (t *Tshark) Instance() *instance.Instance
  • func (t *Tshark) PreStart(ctx context.Context) error

Constants

const (
	DefaultImage = "ghcr.io/celestiaorg/tshark-s3:pr-11"

	TsharkCaptureFileExtension = ".pcapng"
)

Variables

var (
	ErrCreatingTsharkCollectorInstance      = errors.New("CreatingTsharkCollectorInstance", "error creating tshark collector instance")
	ErrSettingTsharkCollectorImage          = errors.New("SettingTsharkCollectorImage", "error setting image for tshark collector")
	ErrSettingTsharkCollectorMemory         = errors.New("SettingTsharkCollectorMemory", "error setting memory for tshark collector")
	ErrAddingTsharkCollectorVolume          = errors.New("AddingTsharkCollectorVolume", "error adding volume for tshark collector")
	ErrSettingTsharkCollectorEnv            = errors.New("SettingTsharkCollectorEnv", "error setting environment variables for tshark collector")
	ErrAddingTsharkCollectorCapability      = errors.New("AddingTsharkCollectorCapability", "error adding capability for tshark collector")
	ErrCommittingTsharkCollectorInstance    = errors.New("CommittingTsharkCollectorInstance", "error committing tshark collector instance")
	ErrTsharkCollectorNotInitialized        = errors.New("TsharkCollectorNotInitialized", "tshark collector not initialized")
	ErrTsharkCollectorInvalidVolumeSize     = errors.New("TsharkCollectorInvalidVolumeSize", "tshark collector invalid volume size `%s`")
	ErrTsharkCollectorS3RegionOrBucketEmpty = errors.New("TsharkCollectorS3RegionOrBucketEmpty", "tshark collector s3 region or bucket empty")
	ErrSettingTsharkCollectorCPU            = errors.New("SettingTsharkCollectorCPU", "error setting cpu for tshark collector")
)

Types

type Error

type Error = errors.Error

type Tshark

type Tshark struct {
	Image string
	// VolumeSize is the size of the volume to use for the tshark collector
	VolumeSize resource.Quantity
	// S3AccessKey is the access key to use for the s3 server
	S3AccessKey string
	// S3SecretKey is the secret key to use for the s3 server
	S3SecretKey string
	// S3Region is the region of the s3 server
	S3Region string
	// S3Bucket is the bucket to use for the s3 server
	S3Bucket string
	// CreateBucket is the flag to create the bucket if it does not exist
	CreateBucket bool
	// S3KeyPrefix is the key prefix to use for the s3 server
	S3KeyPrefix string
	// S3Endpoint is the endpoint of the s3 server
	S3Endpoint string

	// UploadInterval is the interval at which the tshark collector will upload the pcap file to the s3 server
	UploadInterval time.Duration
	// contains filtered or unexported fields
}

Tshark represents the configuration for the tshark collector

func (*Tshark) Clone

func (t *Tshark) Clone(namePrefix string) (instance.SidecarManager, error)

func (*Tshark) Initialize

func (t *Tshark) Initialize(ctx context.Context, namePrefix string, sysDeps *system.SystemDependencies) error

Initialize initializes the BitTwister sidecar and it is called once the instance.AddSidecar is called

func (*Tshark) Instance

func (t *Tshark) Instance() *instance.Instance

func (*Tshark) PreStart

func (t *Tshark) PreStart(ctx context.Context) error

PreStart is called before the instance is started It is used to prepare the sidecar for the instance to start