Ethereum Metrics Exporter

https://github.com/zilliqa/ethereum-metrics-exporter
Admin
A Prometheus exporter for Ethereum Execution & Consensus clients
Tokens:1,250
Snippets:5
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Docker Quick Start for Ethereum Metrics Exporter

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

Provides a quick start guide using Docker to run the Ethereum Metrics Exporter, connecting to specified consensus and execution node URLs.

```docker
docker run -d -it --name ethereum-metrics-exporter -p 9090:9090 -it zilliqa/ethereum-metrics-exporter --consensus-url=http://localhost:5052 --execution-url=http://localhost:8545
```

--------------------------------

### Building Ethereum Metrics Exporter from Source

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

Instructions for building the Ethereum Metrics Exporter from source using Go, including cloning the repository and compiling the binary.

```go
go get github.com/zilliqa/ethereum-metrics-exporter
cd ./ethereum-metrics-exporter
go build -o ethereum-metrics-exporter .
./ethereum-metrics-exporter
```

--------------------------------

### Docker with Config File for Ethereum Metrics Exporter

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

Demonstrates how to run the Ethereum Metrics Exporter using Docker with a mounted configuration file.

```docker
docker run -d -it --name ethereum-metrics-exporter -v $HOST_DIR_CHANGE_ME/config.yaml:/opt/exporter/config.yaml -p 9090:9090 -it zilliqa/ethereum-metrics-exporter --config /opt/exporter/config.yaml
```

--------------------------------

### Git Branching for Contributions

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

Illustrates the Git workflow for contributing to the project, including creating feature branches, committing changes, and pushing to a remote repository.

```shell
git checkout -b feat/new-metric-profit
git commit -m 'feat(profit): Export new metric: profit'
git push origin feat/new-metric-profit
```

--------------------------------

### Ethereum Metrics Exporter CLI Usage

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

Defines the command-line interface for the Ethereum Metrics Exporter, including available flags for configuration and operation.

```shell
A tool to export the state of ethereum nodes

Usage:
  ethereum-metrics-exporter [flags]

Flags:
      --config string                   config file (default is $HOME/.ethereum-metrics-exporter.yaml)
      --consensus-url string            (optional) URL to the consensus node
      --disk-usage-interval string      (optional) interval for disk usage metrics collection (e.g. 1h, 5m, 30s)
      --execution-modules strings       (optional) execution modules that are enabled on the node
      --execution-url string            (optional) URL to the execution node
  -h, --help                            help for ethereum-metrics-exporter
      --metrics-port int                Port to serve Prometheus metrics on (default 9090)
      --monitored-directories strings   (optional) directories to monitor for disk usage
  -d, --debug bool                      Enable debug mode (default is false)
  -t, --toggle                          Help message for toggle
```

--------------------------------

### Git Workflow for Contributing to Ethereum Metrics Exporter

Source: https://github.com/zilliqa/ethereum-metrics-exporter/blob/main/README.md

This snippet provides the standard Git commands for contributing to the project. It covers creating a feature branch, committing changes with a descriptive message, pushing the branch to the remote, and preparing for a pull request.

```Shell
git checkout -b feat/new-metric-profit
git commit -m 'feat(profit): Export new metric: profit'
git push origin feat/new-metric-profit
```
Tokens:
Raw