Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mention ZKsync configuration #5

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Mention ZKsync configuration #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,26 @@ The docker compose configures the following services:
dashboards located in the [dashboards](./dashboards/) folder. [Configuration](./etc/grafana/).
- Caddy. Acts as a reverse proxy for all the components. [Configuration](./etc/caddy/Caddyfile).

## ZKsync node setup

With default configuration, ZKsync node would run the Prometheus exporter, but won't export logs or traces.
For the exact steps to configure OTLP, refer to the ZKsync documentation, but with the env-based configs, you need to supply the following
variables:

```bash
OPENTELEMETRY_LEVEL=info
OTLP_ENDPOINT=http://127.0.0.1:7280/api/v1/otlp/v1/traces
OTLP_LOGS_ENDPOINT=http://127.0.0.1:4318/v1/logs
```

Additionally, you may expose information about the running binary. This is optional; if not provided, default values will be used:

```bash
POD_NAME=server-0
POD_NAMESPACE=local
SERVICE_NAME=zksync-server
```

## Acknowledgments

The `docker-compose` setup and configuration in this repository are based on the awesome [dockprom](https://github.com/stefanprodan/dockprom),
Expand Down