Skip to content
You are reading Consensys Quorum Plugins development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Hyperledger Besu plugins command line options

This reference describes the syntax of the Hyperledger Besu Command Line Interface (CLI) options and subcommands for plugins that extend Hyperledger Besu. All plugin options are prefixed with plugin

Important

Only the plugin CLI options are listed here, visit the Hyperledger Besu documentation to view the CLI options for the besu command.

Only the CLI options for the plugins you have installed are displayed in the CLI help.

Options

metrics-category

--metrics-category=<metrics-category>[,metrics-category...]...
--metrics-category=BLOCKCHAIN,PEERS,POA
BESU_METRICS_CATEGORY=BLOCKCHAIN,PEERS,POA
metrics-category=["BLOCKCHAIN","PEERS","POA"]

Comma-separated list of categories for which to track Besu metrics. An additional category for when using the validator monitoring plugin is POA.

plugin-encrypted-storage-cipher-provider

--plugin-encrypted-storage-cipher-provider=<cipherProvider>
--plugin-encrypted-storage-cipher-provider=SunJCE
BESU_PLUGIN_ENCRYPTED-STORAGE_CIPHER_PROVIDER=SunJCE
plugin-encrypted-storage-cipher-provider="SunJCE"

Cipher provider used to encrypt data at rest. Defaults to using the first available provider that supports AES/CTR/NoPadding.

Use this option to specify a cipher provider based on performance requirements, or for compliance. For example, to specify a cipher provider that complies with Federal Information Processing Standards (FIPS).

Data is encrypted using the 256-bit AES encryption key.

plugin-encrypted-storage-hashicorp-config

--plugin-encrypted-storage-hashicorp-config=<hashicorpConfig>
--plugin-encrypted-storage-hashicorp-config=/home/hashicorp/config.toml
BESU_PLUGIN_ENCRYPTED-STORAGE_HASHICORP_CONFIG=/home/hashicorp/config.toml
plugin-encrypted-storage-hashicorp-config="/home/hashicorp/config.toml"

Configuration file used to retrieve the 256-bit AES encryption key in HashiCorp Vault.

plugin-encrypted-storage-key

--plugin-encrypted-storage-key=<encryptionKey>
--plugin-encrypted-storage-key=/home/encrypt/encryptionKey
BESU_PLUGIN_ENCRYPTED-STORAGE_KEY=/home/encrypt/encryptionKey
plugin-encrypted-storage-key="/home/encrypt/encryptionKey"

File containing the 256-bit AES encryption key to encrypt the blockchain data at rest.

Use this option when a local file stores the encryption key.

plugin-kafka-enabled

--plugin-kafka-enabled[=<true|false>]
--plugin-kafka-enabled=true
BESU_PLUGIN_KAFKA_ENABLED=true
plugin-kafka-enabled=true

Enables or disables the Kafka event streaming plugin. Default is false.

Tip

Ensure the double quotes are included in the configuration file. Double quotes around boolean values in the configuration file are required for command line options prefixed with plugin.

plugin-kafka-log-filter-addresses

--plugin-kafka-log-filter-addresses=<ContractAddress>[,<ContractAddress>...]...
--plugin-kafka-log-filter-addresses=0xcb4f3cA3777fE16FBF4595Ba48d0eBFAEfEaBEBc
BESU_PLUGIN_KAFKA_LOG_FILTER_ADDRESSES=0xcb4f3cA3777fE16FBF4595Ba48d0eBFAEfEaBEBc
plugin-kafka-log-filter-addresses=["0xcb4f3cA3777fE16FBF4595Ba48d0eBFAEfEaBEBc"]

Smart contract addresses to filter events from.

You can create a schema file to decode the events that are published to Kafka, and present it in a more readable format.

plugin-kafka-log-filter-topics

--plugin-kafka-log-filter-topics=<topicFilter>
--plugin-kafka-log-filter-topics='["0xd3610b1c54575b7f4f0dc03d210b8ac55624ae007679b7a928a4f25a709331a8"]'
BESU_PLUGIN_KAFKA_LOG_FILTER_TOPICS='["0xd3610b1c54575b7f4f0dc03d210b8ac55624ae007679b7a928a4f25a709331a8"]'
plugin-kafka-log-filter-topics='["0xd3610b1c54575b7f4f0dc03d210b8ac55624ae007679b7a928a4f25a709331a8"]'

Filter event logs emitted by smart contracts by topic

You can create a schema file to decode the events that are published to Kafka and present it in a more readable format.

Tip

Ensure single quotes are included around the array of topics.

plugin-kafka-log-schema-file

--plugin-kafka-log-schema-file=<schemaFile>
--plugin-kafka-log-schema-file=/home/node/schema.yml
BESU_PLUGIN_KAFKA_LOG_SCHEMA_FILE=/home/node/schema.yml
plugin-kafka-log-schema-file="/home/node/schema.yml"

Schema file used to decode events specified using the --plugin-kafka-log-filter-addresses and --plugin-kafka-log-filter-topics options.

plugin-kafka-metadata-db-enabled

--plugin-kafka-metadata-db-enabled[=<true|false>]
--plugin-kafka-metadata-db-enabled=false
BESU_PLUGIN_KAFKA_METADATA_DB_ENABLED=false
plugin-kafka-metadata-db-enabled="false"

Enables or disables the storing of event metadata in a local database. Default is true.

Tip

Ensure the double quotes are included in the configuration file. Double quotes around boolean values in the configuration file are required for command line options prefixed with plugin.

plugin-kafka-producer-config-override-enabled

--plugin-kafka-producer-config-override-enabled[=<true|false>]
--plugin-kafka-producer-config-override-enabled=true
BESU_PLUGIN_KAFKA_PRODUCER_CONFIG_OVERRIDE_ENABLED=true
plugin-kafka-producer-config-override-enabled=true

Enables or disables overriding Kafka Producer configuration properties. Default is false.

plugin-kafka-producer-property

--plugin-kafka-producer-property=<property=value>
--plugin-kafka-producer-property=sasl.mechanism=PLAIN
BESU_PLUGIN_KAFKA_PRODUCER_PROPERTY=sasl.mechanism=PLAIN
plugin-kafka-producer-property="sasl.mechanism=PLAIN"

The Kafka Producer configuration property. Can be specified multiple times if multiple properties are required.

plugin-kafka-stream

--plugin-kafka-stream=<STRING>
--plugin-kafka-stream=my-pegasys-stream
BESU_PLUGIN_KAFKA_STREAM=my-pegasys-stream
plugin-kafka-stream="my-pegasys-stream"

Prefix of the Hyperledger Besu data stream displayed in the Kafka platform. Default is pegasys-stream.

plugin-kafka-url

--plugin-kafka-url=<URL>
--plugin-kafka-url=127.0.0.1:9090
BESU_PLUGIN_KAFKA_URL=127.0.0.1:9090
plugin-kafka-url="127.0.0.1:9090"

URL of the Kafka streaming platform. Default is 127.0.0.1:9092

plugin-luna-hsm-connectivity-check-interval

--plugin-luna-hsm-connectivity-check-interval=<INTERVAL>
--plugin-luna-hsm-connectivity-check-interval=20000
BESU_PLUGIN_LUNA_HSM_CONNECTIVITY_CHECK_INTERVAL=20000
plugin-luna-hsm-connectivity-check-interval=20000

Period in milliseconds to check the HSM connection. Re-establishes the connection if required.

Default is 30000.

plugin-luna-hsm-password-file

--plugin-luna-hsm-password-file=<FILE>
--plugin-luna-hsm-password-file=/home/me/node1/password.txt
BESU_PLUGIN_LUNA_HSM_PASSWORD_FILE=/home/me/node1/password.txt
plugin-luna-hsm-password-file="/home/me/node1/password.txt"

Plain text file containing the HSM password to access the partition.

plugin-luna-hsm-private-key-alias

--plugin-luna-hsm-private-key-alias=<ALIAS>
--plugin-luna-hsm-private-key-alias="node1PrivateKey"
BESU_PLUGIN_LUNA_HSM_PRIVATE_KEY_ALIAS="node1PrivateKey"
plugin-luna-hsm-private-key-alias="node1PrivateKey"

Alias of the private key in the HSM.

plugin-luna-hsm-public-key-alias

--plugin-luna-hsm-private-key-alias=<ALIAS>
--plugin-luna-hsm-private-key-alias="node1PrivateKey"
BESU_PLUGIN_LUNA_HSM_PRIVATE_KEY_ALIAS="node1PrivateKey"
plugin-luna-hsm-private-key-alias="node1PrivateKey"

Alias of the public key in the HSM.

plugin-luna-hsm-slot

--plugin-luna-hsm-slot=<SLOT>
--plugin-luna-hsm-slot=0
BESU_PLUGIN_LUNA_HSM_SLOT=0
plugin-luna-hsm-slot=0

Slot on the HSM to use the keys.

plugin-metrics-recent-block-count

--plugin-metrics-recent-block-count=<INTEGER>
--plugin-metrics-recent-block-count=50
BESU_PLUGIN_METRICS_RECENT_BLOCK_COUNT=50
plugin-metrics-recent-block-count="50"

Number of recently added blocks in which to check when metrics are calculated. Default is 100.

ConsenSys has acquired Quorum from J.P. Morgan. Please read the FAQ.
Questions or feedback? You can obtain paid professional support by ConsenSys at quorum@consensys.net