tracker

Documentation

Index

• type CITracker
  • func NewTracker(previewLines int) (*CITracker, error)
  • func (c *CITracker) FailedComputeSimilarityID()
  • func (c *CITracker) FailedDetectLine()
  • func (c *CITracker) GetOutputLines() int
  • func (c *CITracker) TrackFileFound(path string)
  • func (c *CITracker) TrackFileFoundCountLines(countLines int)
  • func (c *CITracker) TrackFileIgnoreCountLines(countLines int)
  • func (c *CITracker) TrackFileParse(path string)
  • func (c *CITracker) TrackFileParseCountLines(countLines int)
  • func (c *CITracker) TrackQueryExecuting(queryAggregation int)
  • func (c *CITracker) TrackQueryExecution(queryAggregation int)
  • func (c *CITracker) TrackQueryLoad(queryAggregation int)
  • func (c *CITracker) TrackScanPath()
  • func (c *CITracker) TrackScanSecret()
  • func (c *CITracker) TrackVersion(retrievedVersion model.Version)

Types

type CITracker

type CITracker struct {
	ExecutingQueries   int
	ExecutedQueries    int
	FoundFiles         int
	FailedSimilarityID int
	LoadedQueries      int
	ParsedFiles        int
	ScanSecrets        int
	ScanPaths          int

	FoundCountLines  int
	ParsedCountLines int
	IgnoreCountLines int
	Version          model.Version
	BagOfFilesParse  map[string]int
	BagOfFilesFound  map[string]int
	// contains filtered or unexported fields
}

func NewTracker

func NewTracker(previewLines int) (*CITracker, error)

NewTracker will create a new instance of a tracker with the number of lines to display in results output number of lines can not be smaller than 1

func (*CITracker) FailedComputeSimilarityID

func (c *CITracker) FailedComputeSimilarityID()

FailedComputeSimilarityID - queries that failed to compute similarity ID

func (*CITracker) FailedDetectLine

func (c *CITracker) FailedDetectLine()

FailedDetectLine - queries that fail to detect line are counted as failed to execute queries

func (*CITracker) GetOutputLines

func (c *CITracker) GetOutputLines() int

GetOutputLines returns the number of lines to display in results output

func (*CITracker) TrackFileFound

func (c *CITracker) TrackFileFound(path string)

TrackFileFound adds a found file to be scanned

func (*CITracker) TrackFileFoundCountLines

func (c *CITracker) TrackFileFoundCountLines(countLines int)

TrackFileFoundCountLines - information about the lines of the scanned files

func (*CITracker) TrackFileIgnoreCountLines

func (c *CITracker) TrackFileIgnoreCountLines(countLines int)

TrackFileIgnoreCountLines - information about the lines ignored of the parsed files

func (*CITracker) TrackFileParse

func (c *CITracker) TrackFileParse(path string)

TrackFileParse adds a successful parsed file to be scanned

func (*CITracker) TrackFileParseCountLines

func (c *CITracker) TrackFileParseCountLines(countLines int)

TrackFileParseCountLines - information about the lines of the parsed files

func (*CITracker) TrackQueryExecuting

func (c *CITracker) TrackQueryExecuting(queryAggregation int)

TrackQueryExecuting adds a executing queries

func (*CITracker) TrackQueryExecution

func (c *CITracker) TrackQueryExecution(queryAggregation int)

TrackQueryExecution adds a query executed

func (*CITracker) TrackQueryLoad

func (c *CITracker) TrackQueryLoad(queryAggregation int)

TrackQueryLoad adds a loaded query

func (*CITracker) TrackScanPath

func (c *CITracker) TrackScanPath()

TrackScanPath - paths to preform scan

func (*CITracker) TrackScanSecret

func (c *CITracker) TrackScanSecret()

TrackScanSecret - add to secrets scanned

func (*CITracker) TrackVersion

func (c *CITracker) TrackVersion(retrievedVersion model.Version)

TrackVersion - information if current version is latest