reporters

Documentation

Index

• Constants
• func FlowTokenTypeID(chain flow.Chain) string
• func NewBalanceReporter(chain flow.Chain, snapshot snapshot.StorageSnapshot) *balanceProcessor
• func NewStorageSnapshotFromPayload(payloads []ledger.Payload) snapshot.MapStorageSnapshot
• type AccountReporter
  • func (r *AccountReporter) Name() string
  • func (r *AccountReporter) Report(payload []ledger.Payload, commit ledger.State) error
• type AtreeReporter
  • func (r *AtreeReporter) Name() string
  • func (r *AtreeReporter) Report(payloads []ledger.Payload, commit ledger.State) error
• type ExportReport
• type ExportReporter
  • func NewExportReporter(logger zerolog.Logger, getBeforeMigrationSCFunc GetStateCommitmentFunc) *ExportReporter
  • func (e *ExportReporter) Name() string
  • func (e *ExportReporter) Report(payload []ledger.Payload, commit ledger.State) error
• type FungibleTokenTracker
  • func NewFungibleTokenTracker(logger zerolog.Logger, rwf ReportWriterFactory, chain flow.Chain, ...) *FungibleTokenTracker
  • func (r *FungibleTokenTracker) Name() string
  • func (r *FungibleTokenTracker) Report(payloads []ledger.Payload, commit ledger.State) error
• type GetStateCommitmentFunc
• type ReportFileWriter
  • func (r *ReportFileWriter) Close()
  • func (r *ReportFileWriter) Write(dataPoint interface{})
• type ReportFileWriterFactory
  • func NewReportFileWriterFactory(outputDir string, log zerolog.Logger) *ReportFileWriterFactory
  • func NewReportFileWriterFactoryWithFormat(outputDir string, log zerolog.Logger, format ReportFormat) *ReportFileWriterFactory
  • func (r *ReportFileWriterFactory) Filename(dataNamespace string) string
  • func (r *ReportFileWriterFactory) ReportWriter(dataNamespace string) ReportWriter
• type ReportFormat
• type ReportNilWriter
  • func (r ReportNilWriter) Close()
  • func (r ReportNilWriter) Write(_ interface{})
• type ReportWriter
  • func NewReportFileWriter(fileName string, log zerolog.Logger, format ReportFormat) ReportWriter
• type ReportWriterFactory
• type TokenDataPoint

Constants

const (
	CBORTagInlineCollisionGroup   = 253
	CBORTagExternalCollisionGroup = 254
)

const FungibleTokenTrackerReportPrefix = "fungible_token_report"

Functions

func FlowTokenTypeID

func FlowTokenTypeID(chain flow.Chain) string

func NewBalanceReporter

func NewBalanceReporter(
	chain flow.Chain,
	snapshot snapshot.StorageSnapshot,
) *balanceProcessor

func NewStorageSnapshotFromPayload

func NewStorageSnapshotFromPayload(
	payloads []ledger.Payload,
) snapshot.MapStorageSnapshot

NewStorageSnapshotFromPayload returns an instance of StorageSnapshot with entries loaded from payloads (should only be used for migration)

Types

type AccountReporter

type AccountReporter struct {
	Log   zerolog.Logger
	RWF   ReportWriterFactory
	Chain flow.Chain
}

AccountReporter iterates through registers keeping a map of register sizes reports on storage metrics

func (*AccountReporter) Name

func (r *AccountReporter) Name() string

func (*AccountReporter) Report

func (r *AccountReporter) Report(payload []ledger.Payload, commit ledger.State) error

type AtreeReporter

type AtreeReporter struct {
	Log zerolog.Logger
	RWF ReportWriterFactory
}

AtreeReporter iterates payloads and generates payload and atree stats.

func (*AtreeReporter) Name

func (r *AtreeReporter) Name() string

func (*AtreeReporter) Report

func (r *AtreeReporter) Report(payloads []ledger.Payload, commit ledger.State) error

type ExportReport

type ExportReport struct {
	EpochCounter            uint64
	PreviousStateCommitment flow.StateCommitment
	CurrentStateCommitment  flow.StateCommitment
	ReportSucceeded         bool
}

type ExportReporter

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

ExportReporter writes data that can be leveraged outside of extraction

func NewExportReporter

func NewExportReporter(
	logger zerolog.Logger,
	getBeforeMigrationSCFunc GetStateCommitmentFunc,
) *ExportReporter

func (*ExportReporter) Name

func (e *ExportReporter) Name() string

func (*ExportReporter) Report

func (e *ExportReporter) Report(payload []ledger.Payload, commit ledger.State) error

type FungibleTokenTracker

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

FungibleTokenTracker iterates through stored cadence values over all accounts and check for any value with the given resource typeID

func NewFungibleTokenTracker

func NewFungibleTokenTracker(logger zerolog.Logger, rwf ReportWriterFactory, chain flow.Chain, vaultTypeIDs []string) *FungibleTokenTracker

func (*FungibleTokenTracker) Name

func (r *FungibleTokenTracker) Name() string

func (*FungibleTokenTracker) Report

func (r *FungibleTokenTracker) Report(payloads []ledger.Payload, commit ledger.State) error

Report creates a fungible_token_report_*.json file that contains data on all fungible token Vaults in the state commitment. I recommend using gojq to browse through the data, because of the large uint64 numbers which jq won't be able to handle.

type GetStateCommitmentFunc

type GetStateCommitmentFunc func() flow.StateCommitment

type ReportFileWriter

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

func (*ReportFileWriter) Close

func (r *ReportFileWriter) Close()

func (*ReportFileWriter) Write

func (r *ReportFileWriter) Write(dataPoint interface{})

type ReportFileWriterFactory

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

func NewReportFileWriterFactory

func NewReportFileWriterFactory(outputDir string, log zerolog.Logger) *ReportFileWriterFactory

func NewReportFileWriterFactoryWithFormat

func NewReportFileWriterFactoryWithFormat(outputDir string, log zerolog.Logger, format ReportFormat) *ReportFileWriterFactory

func (*ReportFileWriterFactory) Filename

func (r *ReportFileWriterFactory) Filename(dataNamespace string) string

func (*ReportFileWriterFactory) ReportWriter

func (r *ReportFileWriterFactory) ReportWriter(dataNamespace string) ReportWriter

type ReportFormat

type ReportFormat uint8

const (
	// ReportFormatJSONArray represents format encoded as JSON array at the top level.
	ReportFormatJSONArray ReportFormat = iota

	// ReportFormatJSONL represents format encoded as JSONL.
	// ReportFormatJSONL should be used when report might be large enough to
	// crash tools like jq (if JSON array is used instead of JSONL).
	ReportFormatJSONL
)

type ReportNilWriter

type ReportNilWriter struct {
}

ReportNilWriter does nothing. Can be used as the final fallback writer

func (ReportNilWriter) Close

func (r ReportNilWriter) Close()

func (ReportNilWriter) Write

func (r ReportNilWriter) Write(_ interface{})

type ReportWriter

type ReportWriter interface {
	Write(dataPoint interface{})
	Close()
}

ReportWriter writes data from reports

func NewReportFileWriter

func NewReportFileWriter(fileName string, log zerolog.Logger, format ReportFormat) ReportWriter

type ReportWriterFactory

type ReportWriterFactory interface {
	ReportWriter(dataNamespace string) ReportWriter
}

TODO janezp: we should be able to switch the report writer to write to a database.

type TokenDataPoint

type TokenDataPoint struct {
	// Path is the storage path of the composite the vault was found in
	Path string `json:"path"`
	// Address is the owner of the composite the vault was found in
	Address string `json:"address"`
	// Balance is the balance of the flow vault
	Balance uint64 `json:"balance"`
	// token type
	TypeID string `json:"type_id"`
}