Monitoring

The module used for integration is the OpenTelemetryModule. It is responsible for collecting metrics and traces and exporting them to the otel collector and prometheus.

Configure the module:

...
// modules config
Sequencer: {
    OpenTelemetryServer
}
...
 
appchain.configure({
    ...
    Sequencer: {
        OpenTelemetryServer: {
            metrics: {
                enabled: true
                prometheus: {
                    host: "prometheus",
                    port: 4320,
                    appendTimestamp: true
                },
                nodeScrapeInterval: 10, // interval in seconds
            },
            tracing: {
                enabled: true
                otlp: {
                    url: "http://otel-collector:4317"
                }
            },
        },
    }
});

Docker-compose files can be found in packages/deployment/docker/deployment.

For detailed configuration in regards to different protokit environment configurations, see the starter-kit section. For example, the sovereign environment has monitoring configured by default.

There are a bunch of environment variables prefixed with OPEN_TELEMETRY* that handle configuration of the monitoring features. Default values are set for correct communication with the default docker services.

Additionally, configure the default grafana user password using the GF_SECURITY_ADMIN* environment variables.

Spin up the docker-services using pnpm env:your-environment docker:up.

Grafana should be available at http://localhost:3001