Skip to content
You are reading Codefi Orchestrate development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Configure Codefi Orchestrate monitoring

Follow these steps to configure monitoring when starting the following services:

Tip

Configure each microservice using microservice-specific environment variables. Command line options are also available and take precedence over environment variables.

Configuration: Logging

Codefi Orchestrate supports multiple log levels:

  • debug: With DEBUG, you start to include more granular, diagnostic information. This amount of information can be overwhelming in a production environment.
  • info: INFO messages correspond to normal application state changes and milestones. You probably won’t care too much about these entries during normal operations, but they provide the skeleton of what happened.
  • warn: WARN log level indicates that you might have a problem and that you’ve detected an unusual situation.
  • error: An error is a serious issue and represents the failure of something important going on in your application.
  • fatal: FATAL represents truly catastrophic situations. Your application is about to abort to prevent some kind of corruption or serious problem.

Orchestrate also supports the following log formats:

  • text: Displays the log message in plain text
  • json: Displays the log message in JSON.
Environment Variable Command line option Description Default
LOG_LEVEL log-level Minimum log level to display info
LOG_FORMAT log-format Log format to use text
LOG_TIMESTAMP log-timestamp Whether to add the timestamp to the log message when using text log format false

Configuration: Metrics

Codefi Orchestrate exposes different type of metrics that can help monitor its state.

Orchestrate exposes the following metric modules:

  • healtz: Health metrics used to assert the state of the server.
  • go: Metrics specific to the Go programming language.
  • process: Refers to the CPU/Memory state of the instance you are running the service.
  • application: Refers to state application metrics like the number of pending jobs.
  • ENABLED: Enable all metric modules.
  • DISABLED: Disable all metric modules.
Environment Variable Command line option Description Default
METRICS_HOSTNAME metrics-hostname Hostname to expose metrics services
METRICS_PORT metrics-port Port to expose metrics services 8082
METRICS_MODULES metrics-modules List of metrics modules exposed (comma separated) ENABLED
ConsenSys has acquired Quorum from J.P. Morgan. Please read the FAQ.
Questions or feedback? You can obtain paid professional support by Consensys at orchestrate@consensys.net