Accessing the Metric Insights Log Files

Metric Insights is a dockerized application. All logs from Docker containers are stored in one directory /opt/mi/log.

Table of contents:

  1. Access the Log Files
    1. Access Log Files via Status Monitor
    2. Access Log Files via MI Console
    3. Access Log Files Directly via Docker Containers
  2. Log Files Description
  3. Additional Logging Options

NOTE: Metric Insights' logs follow the ISO-8601 standard of date and time representation.

  • Example: 2025-01-23 10:35:00

1. Access the Log Files

1.1. Access Log Files via Status Monitor

Access Admin > Status Monitor > Errors & Logs tab

NOTE: Logs from Status Monitor do not include Docker container logs, which can be accessed via MI Console or directly via Docker containers.

  1. [Get Error Logs]
  2. From the pop-up, you can download the logs (zipped) to your local machine or send them to our support team for assistance

Access Verbose Logs from Status Monitor

NOTE: Verbose logging can be enabled for specific application errors. This is controlled by the System Variable ENABLE_APPLICATION_ERROR_LOGGING_INTO_DB. See Additional Logging Options for details on enabling it.

  1. Click on the Error Message
  2. Copy the link and open it in the browser
    • The link has the following format: <hostname>/admin/log/?id=<log id>
  3. The verbose log is displayed in the Trace log section

1.2. Access Log Files via MI Console

See the Logs section of the MI Console Overview article for details.

1.3. Access Log Files Directly via Docker Containers

All system logs are stored in the web container at /opt/mi/log. To access log files for a specific service, navigate to /opt/mi/log inside the corresponding container.

2. Log Files Description

See the logs description for your MI version and deployment type in the corresponding section:

MI v7

Simple Installation

Types of Logs Description
console.log Log of the console container.
da-index-update.log Log of the index-update service in the data-analyzer container.
da-main.log Log of the data-analyzer service.
data-analyzer.log Log of the data-analyzer container.
dataprocessor.log Log of the dataprocessor container.
image-generator.log Log of the image-generator container.
logger-debug.log Detailed log of the logcollector service, which is responsible for generating patcher.log.
logger.log Log of the logcollector service, which is responsible for generating patcher.log.
mi.log Log of the PHP application (migration-tool).
mysql.log Log of the MySQL container (optional).
patcher.log List of applied patches.
patcher.debug Detailed log of the patcher service, explaining the processing of applying patches.
redis.log Log of the Redis container.
web.log Log of the web container.

Orchestrated Environments

Container Logs are managed by the orchestration service and can be accessed using the respective commands:

  • Kubernetes (K8s): Use kubectl logs -n <namespace> <pod id>.
  • ECS: All logs are available in AWS CloudWatch.
  • Docker Swarm: Use the default Docker command: docker logs.

The table below describes log files available for all orchestrated environments.

Types of Logs Description
console.log Log of the console application.
da-index-update.log Log of the index-update service in the data-analyzer module.
da-main.log Log of the data-analyzer service.
logger-debug.log Detailed log of the logcollector service, which is responsible for generating patcher.log.
logger.log Log of the logcollector service, which is responsible for generating patcher.log.
mi.log Log of the PHP application (migration-tool).
patcher.log List of applied patches.
patcher.debug Detailed log of the patcher service, explaining the processing of applying patches.

MI v6

Simple Installation

Types of Logs Description
mi.log, mi.debug, mi.error General logs from the UI and generator (migration utility scripts)
dataprocessor.log Logs from the Data Processor service
seed.log Logs from the Data Processor Seed Node service
mysql.log mysql.log
web.log Logs from the Web Service

Orchestrated Environments

Types of Logs Description
mi.log, mi.debug, mi.error General logs from the UI and generator (migration utility scripts)
mi.system Sytem logs
network.log Network logs
patcher.log Logs from the Patcher
tomcat-access.log, application.log, insight.log Logs from the Dataprocessor

3. Additional Logging Options

Access Admin > System > System Variables

NOTE: See Setting System Variables for details on System Variables configuration.

Logging for different components of MI application can be configured via System Variables:

  1. Enter Logging in the search field Set  
  2. Set ALLOW_EXT_LINK_TRACKING to 'Y' to enable tracking of links to 3rd party reporting tools from emails. This information is stored in dashboard_element_view_log_detail table in the dashboard database
  3. Set EMAIL_LOGGING to 'Y' to generate a log file of email digest activity for troubleshooting
  4. Set ENABLE_APPLICATION_ERROR_LOGGING_INTO_DB to 'Y' to enable more detailed MI application error logs, accessible via Admin > Status Monitor > Errors & Logs
    • See Access Verbose Logs in Status Monitor for details
    • NOTE: This System Variables configures only MI application errors and does not include Data Source connection errors, which have separate logging in the dataprocessor container.