Skip to main content

Configure Codefi Orchestrate monitoring

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


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 VariableCommand line optionDescriptionDefault
LOG_LEVELlog-levelMinimum log level to displayinfo
LOG_FORMATlog-formatLog format to usetext
LOG_TIMESTAMPlog-timestampWhether to add the timestamp to the log message when using text log formatfalse

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 VariableCommand line optionDescriptionDefault
METRICS_HOSTNAMEmetrics-hostnameHostname to expose metrics services
METRICS_PORTmetrics-portPort to expose metrics services8082
METRICS_MODULESmetrics-modulesList of metrics modules exposed (comma separated)ENABLED