Summary
The --metrics-port CLI flag currently runs the API server on the specified port. However, the API server now serves multiple endpoints beyond just metrics:
Proposal
Rename --metrics-port to --api-port to better reflect that it configures the full API server port, not just metrics.
Files to Update
pkgs/cli/src/main.zig - CLI argument definitionpkgs/cli/src/node.zig - NodeOptions structpkgs/cli/src/constants.zig - Default port constantpkgs/cli/src/prometheus.zig - Prometheus config generation- Documentation/README files
Considerations
- Check if there's a standard naming convention among other Ethereum clients
- This will require corresponding changes in
lean-quickstart repository
- Consider backwards compatibility (deprecation warning for old flag?)
Related
Summary
The
--metrics-portCLI flag currently runs the API server on the specified port. However, the API server now serves multiple endpoints beyond just metrics:/metrics- Prometheus metrics/health- Health check/events- SSE events/lean/states/finalized- Finalized checkpoint state (new in hosting and consuming checkpoint sync server API #479)Proposal
Rename
--metrics-portto--api-portto better reflect that it configures the full API server port, not just metrics.Files to Update
pkgs/cli/src/main.zig- CLI argument definitionpkgs/cli/src/node.zig- NodeOptions structpkgs/cli/src/constants.zig- Default port constantpkgs/cli/src/prometheus.zig- Prometheus config generationConsiderations
lean-quickstartrepositoryRelated