Getting started with Hyperledger Besu

Developer Quickstart with Splunk

To view the Quickstart network logs in Splunk:

1. Start the Developer Quickstart with Besu. When you run the Quickstart script, you will be offered the option to select a monitoring solution as part of a step by step wizard. Please make sure to select splunk monitoring in the list offered.
2. Open the Splunk UI.

Splunk Connect for Ethereum Docker Compose

With this method you can run a development Besu node and connect it to Splunk Enterprise, using the Splunk Connect for Ethereum demonstration Docker Compose environment provided by Splunk. You can set up the example by following these steps:

Use Splunk Enterprise as a Docker container

LOGGER=Splunk \
SPLUNK_URL=https://localhost:8088 \
SPLUNK_TOKEN=11111111-1111-1111-1111-1111111111113 \
SPLUNK_SKIPTLSVERIFY=true \
besu \
--network=dev \
--miner-coinbase=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 \
--miner-enabled \
--logging=trace

Run a Splunk Enterprise instance

Procedure

1. Configure OpenTelemetry to accept data from Besu. For example, use the following configuration for your otel-collector-config.yml file, and send data to Splunk and Splunk APM:

receivers:
     otlp:    
          protocols:             
          grpc:             
          http: 
          
exporters:
     splunk_hec/traces:
              # Splunk HTTP Event Collector token.         
              token: "11111111-1111-1111-1111-1111111111113"         
              # URL to a Splunk instance to send data to.         
              endpoint: "https://<SPLUNK INSTANCE>:8088/services/collector"         
              # Optional Splunk source: https://docs.splunk.com/Splexicon:Source         
              source: "besu:traces"         
              # Optional Splunk source type: https://docs.splunk.com/Splexicon:Sourcetype         
              sourcetype: "otlp"         
              # Splunk index, optional name of the Splunk index targeted.         
              index: "traces"         
              # Maximum HTTP connections to use simultaneously when sending data. Defaults to 100.         
              max_connections: 20         
              # Whether to disable gzip compression over HTTP. Defaults to false.         
              disable_compression: false         
              # HTTP timeout when sending data. Defaults to 10s.         
              timeout: 10s         
              # Whether to skip checking the certificate of the HEC endpoint when sending data over HTTPS. Defaults to false.         
              # For this demo, we use a self-signed certificate on the Splunk docker instance, so this flag is set to true.         
              insecure_skip_verify: true     
         splunk_hec/metrics:     
              # Splunk HTTP Event Collector token.         
              token: "11111111-1111-1111-1111-1111111111113"         
              # URL to a Splunk instance to send data to.         
              endpoint: "https://<SPLUNK INSTANCE>:8088/services/collector"         
              # Optional Splunk source: https://docs.splunk.com/Splexicon:Source         
              source: "besu:metrics"         
              # Optional Splunk source type: https://docs.splunk.com/Splexicon:Sourcetype         
              sourcetype: "prometheus"         
              # Splunk index, optional name of the Splunk index targeted.         
              index: "metrics"         
              # Maximum HTTP connections to use simultaneously when sending data. Defaults to 100.         
              max_connections: 20         
              # Whether to disable gzip compression over HTTP. Defaults to false.         
              disable_compression: false         
              # HTTP timeout when sending data. Defaults to 10s.         
              timeout: 10s         
              # Whether to skip checking the certificate of the HEC endpoint when sending data over HTTPS. Defaults to false.         
              # For this demo, we use a self-signed certificate on the Splunk docker instance, so this flag is set to true.         
              insecure_skip_verify: true     
          # Traces     
          sapm:         
              access_token: "${SPLUNK_ACCESS_TOKEN}"         
              endpoint: "https://ingest.${SPLUNK_REALM}.signalfx.com/v2/trace"     
          # Metrics + Events  
          signalfx:         
              access_token: "${SPLUNK_ACCESS_TOKEN}"         
              realm: "${SPLUNK_REALM}" 
              
 processors:     
     batch: 
     
 extensions:     
     health_check:     
     pprof:     
     zpages: 
     
 service:     
     extensions: [pprof, zpages, health_check]     
     pipelines:    
          traces:      
              receivers: [otlp]             
              exporters: [splunk_hec/traces, sapm]             
              processors: [batch]         
          metrics:             
              receivers: [otlp]             
              exporters: [splunk_hec/metrics, signalfx]             
              processors: [batch]

It is easiest to run the OpenTelemetry collector with Docker with the following command:

1. You can also refer to this Docker-compose example.

2. Start Besu with the --metrics-enabled and --metrics-protocol=opentelemetry options. For example, run the following command to start a single node:

The OpenTelemetry SDK mandates how to configure the OpenTelemetry gRPC client, so data flows to the collector from Besu.

You can use the following environment variables: