package
3.0.0-alpha5+incompatible
Repository: https://github.com/erigontech/erigon.git
Documentation: pkg.go.dev

# README

Diagnostics commands

Diagnostics command architecture

Diagnostics command is implemented to retrieve information from the Erigon node on a headless machine. It makes it easier to run and get information from the node as it runs on the same machine and doesn't require a PIN-secured remote connection. This is done to make the diagnostics process quicker to set up and make the entire process less resistant.

Diagnostics command local connection diagram

overview

Compare with remote connection

Available commands

databasesDisplays information about databases. Details
downloaderDisplays info about the snapshot download process
stagesDisplays the current status of node synchronization
uiServes local UI interface to browse through all info collected by diagnostics

Global flags

FlagDefault ValueAllowed ValuesDescription
debug.addr"localhost:6060"stringAddress of diagnostics endpoint in Erigon node. This endpoint must match the values of diagnostics.endpoint.addr:diagnostics.endpoint.port. By default, it is localhost:6060.
outputtexttext, jsonDefines the output format for diagnostics data. It can be either text or json. text means that the output will be prettified, json means that the output will be in JSON format. By default, the output is in text format.
helpShows details about the command

Databases

./build/bin/diag databases

Available flags:

FlagDefault ValueAllowed ValuesDescription
db.appearance.populatedfalsebooleanPrint only for populated tables content.
db.name""stringDB name to print info about. If not set, all DBs will be printed.

Examples:

  • ./build/bin/diag databases img
  • ./build/bin/diag databases --db.name=caplin/indexing/beacon_indicies img
  • ./build/bin/diag databases --db.name=caplin/indexing/beacon_indicies --db.appearance.populated img

Downloader

./build/bin/diag downloader Display Snapshot download status

Available subcommands:

filesDisplays status for each file along with overall download status

Available flags:

FlagDefault ValueAllowed ValuesDescription
downloader.file.filterallall, active, inactive, downloaded, queuedFilter files to display.
downloader.file.name""stringFile name to print details about.

Examples:

  • ./build/bin/diag downloader img
  • ./build/bin/diag downloader files img
  • ./build/bin/diag downloader files --downloader.file.filter=downloaded img
  • ./build/bin/diag downloader files --downloader.file.name=v1-005400-005500-transactions.seg img

Stages

./build/bin/diag stages current Display node synchronization status

Example output:

img

UI

./build/bin/diag ui Serve diagnostics ui locally

Available flags:

FlagDefault ValueAllowed ValuesDescription
ui.addr127.0.0.1:6060stringURL to serve UI web application.

After running this command, it enables you to navigate through all available diagnostics data using a web application. You can see what is currently available. This command allows you to skip the session setup to connect to your node as it automatically connects to a running node.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author