mindreader

package
v1.20.0 Latest Latest
Warning

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

 Go to latest Published: Sep 22, 2026 License: Apache-2.0 Imports: 34 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var TestModeBlocksCompared = testModeMetrics.NewCounter("blocks_compared_total", "Total number of blocks successfully compared (matched + mismatched)")
View Source 
var TestModeBlocksComparedMatched = testModeMetrics.NewCounter("blocks_compared_matched_total", "Total number of blocks that matched production")
View Source 
var TestModeBlocksComparedMismatched = testModeMetrics.NewCounter("blocks_compared_mismatched_total", "Total number of blocks that did not match production")
View Source 
var TestModeBlocksFetchFailure = testModeMetrics.NewCounter("blocks_fetch_failure_total", "Total number of blocks that failed to fetch from production")
View Source 
var TestModeBlocksReorg = testModeMetrics.NewCounter("blocks_reorg_total", "Total number of blocks skipped due to re-org (block ID mismatch)")
View Source 
var TestModeBlocksSeen = testModeMetrics.NewCounter("blocks_seen_total", "Total number of blocks seen in test mode (includes all blocks attempted)")

Counter metrics

View Source 
var TestModeFailurePercentage = testModeMetrics.NewGauge("failure_percentage", "Percentage of compared blocks that did not match production")
View Source 
var TestModeSuccessPercentage = testModeMetrics.NewGauge("success_percentage", "Percentage of compared blocks that matched production")

Gauge metrics for percentages

Functions

func ParseTestModeDSN added in v1.11.3 

func ParseTestModeDSN(dsn string) (endpoint string, apiKey string, apiToken string, insecure bool, plaintext bool, err error)

ParseTestModeDSN parses the DSN format: http(s)://host:port[?insecure=true][&apiKey=key] Also checks FIREHOSE_API_KEY and FIREHOSE_API_TOKEN environment variables

Types

type Archiver 

type Archiver struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewArchiver 

func NewArchiver(
	startBlock uint64,
	oneblockSuffix string,
	localOneBlocksStore dstore.Store,
	remoteOneBlocksStore dstore.Store,
	logger *zap.Logger,
	tracer logging.Tracer,
) *Archiver

func (*Archiver) Start 

func (a *Archiver) Start(ctx context.Context)

func (*Archiver) StoreBlock 

func (a *Archiver) StoreBlock(ctx context.Context, block *pbbstream.Block) error

type BlockLineConsoleReader added in v1.20.0 

type BlockLineConsoleReader interface {
	ConsolerReader

	ReadLines(lines <-chan consoleline.Line)
}

BlockLineConsoleReader is a ConsolerReader that reads "FIRE BLOCK" lines whose payload was decoded while it was read out of the node, see consoleline.Splitter. Its lines then come from the channel given to ReadLines instead of the one given to its factory.

type CloseableConsoleReader added in v1.1.0 

type CloseableConsoleReader interface {
	ConsolerReader

	Close() error
}

type ConsolerReader 

type ConsolerReader interface {
	ReadBlock() (obj *pbbstream.Block, err error)
	Done() <-chan interface{}
}

type ConsolerReaderFactory 

type ConsolerReaderFactory func(lines chan string) (ConsolerReader, error)

type FileUploader 

type FileUploader struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewFileUploader 

func NewFileUploader(localStore dstore.Store, destinationStore dstore.Store, logger *zap.Logger) *FileUploader

func (*FileUploader) Done added in v1.16.1 

func (fu *FileUploader) Done() <-chan struct{}

Done is closed once the upload loop has fully stopped, after a final upload pass has drained the remaining local files.

func (*FileUploader) Start 

func (fu *FileUploader) Start(ctx context.Context)

type MindReaderPlugin 

type MindReaderPlugin struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewMindReaderPlugin 

func NewMindReaderPlugin(
	oneBlocksStoreURL string,
	workingDirectory string,
	consoleReaderFactory ConsolerReaderFactory,
	startBlockNum uint64,
	stopBlockNum uint64,
	channelCapacity int,
	headBlockUpdater nodeManager.HeadBlockUpdater,
	shutdownFunc func(error),
	oneBlockSuffix string,
	blockStreamServer *blockstream.Server,
	testModeComparator *TestModeComparator,
	zlogger *zap.Logger,
	tracer logging.Tracer,
) (*MindReaderPlugin, error)

NewMindReaderPlugin initiates its own: * ConsoleReader (from given Factory) * Archiver (from archive store params) * Shutter

func (*MindReaderPlugin) LastSeenBlock 

func (p *MindReaderPlugin) LastSeenBlock() bstream.BlockRef

GetMindreaderLineChannel is a marker method that `superviser.Superviser` uses to determine if `logplugin.LogPlugin` is an actual mindreader plugin without depending on the `mindreader` package in which case it would create an import cycle.

The `superviser.Superviser` defines `type mindreaderPlugin interface { LastSeenBlockNum() bstream.BlockRef }` which is respected. This is a trick to avoid circual dependency in imports.

func (*MindReaderPlugin) Launch 

func (p *MindReaderPlugin) Launch()

func (*MindReaderPlugin) LogBlockLine added in v1.20.0 

func (p *MindReaderPlugin) LogBlockLine(block *consoleline.Block)

LogBlockLine receives a "FIRE BLOCK" line whose payload was decoded while it was read.

func (*MindReaderPlugin) LogLine 

func (p *MindReaderPlugin) LogLine(in string)

LogLine receives log line and write it to "pipe" of the local console reader

func (*MindReaderPlugin) Name 

func (p *MindReaderPlugin) Name() string

func (*MindReaderPlugin) OnBlockWritten 

func (p *MindReaderPlugin) OnBlockWritten(callback nodeManager.OnBlockWritten)

func (*MindReaderPlugin) ReadsBlockLines added in v1.20.0 

func (p *MindReaderPlugin) ReadsBlockLines() bool

ReadsBlockLines reports whether "FIRE BLOCK" lines must be given to LogBlockLine instead of LogLine. It is only meaningful once the plugin is launched.

func (*MindReaderPlugin) Stop 

func (p *MindReaderPlugin) Stop()

type TestModeComparator added in v1.11.3 

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

func NewTestModeComparator added in v1.11.3 

func NewTestModeComparator(config *TestModeConfig, registry *fcproto.Registry, sanitizer func(pbbstream *pbbstream.Block) *pbbstream.Block, logger *zap.Logger) (*TestModeComparator, error)

func (*TestModeComparator) AgainstDSN added in v1.11.3 

func (c *TestModeComparator) AgainstDSN() string

func (*TestModeComparator) Close added in v1.11.3 

func (c *TestModeComparator) Close() error

Close is safe to call multiple times, from any goroutine. The comparator is shut down from more than one place depending on the app: `reader-node` closes it from the mindreader consume flow, `reader-node-firehose` from the app's `Run`, and a nil comparator (test mode disabled) closes to a no-op.

func (*TestModeComparator) CompareBlock added in v1.11.3 

func (c *TestModeComparator) CompareBlock(ctx context.Context, testingBlock *pbbstream.Block) error

func (*TestModeComparator) DiffOutput added in v1.11.3 

func (c *TestModeComparator) DiffOutput() string

func (*TestModeComparator) MarshalLogObject added in v1.11.3 

func (c *TestModeComparator) MarshalLogObject(enc zapcore.ObjectEncoder) error

type TestModeConfig added in v1.11.3 

type TestModeConfig struct {
	Enabled    bool
	AgainstDSN string
	DiffOutput string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.