Abstract
M-Files can be configured to log what requests does it send to IDOL and what responses does it get. This is usefully when monitoring the flow of indexing and what kind of content is getting indexed.This document describes how to configure M-Files to log M-Files Requests and IDOL Responses.
NOTE! This document concerns M-Files 20.6 and newer.
Keywords: IDOL, index, logging
Configuration
- Open admin tool > Configurations
- Select Advanced vault Settings > Configuration > Search > Indexes > [index name] > Additional Options
- Select Advanced tab
- Add "logPath": "[path to log folder]"
Example: "logPath": "C:\\Logs"
Note. Escape all backslashes with additional backslash e.g. C:\\Logs\\folder2
Example including the JSON tree:
{
"generatedIndexName": "MF-{17E2AF7E-D782-4573-84EF-94CAE7CD30A0}",
"partitionCount": 1,
"useLanguageAnalysis": true,
"logPath": "C:\\Logs",
"plainTextExtraction": {
"useCfs": false
},
"limitsForIndexedData": {
"maxFieldLengthKb": 1000000,
"maxTotalFileDataLengthKb": 1000000
}
}
Note. Escape all backslashes with additional backslash e.g. C:\\Logs\\folder2
Example including the JSON tree:
{
"generatedIndexName": "MF-{17E2AF7E-D782-4573-84EF-94CAE7CD30A0}",
"partitionCount": 1,
"useLanguageAnalysis": true,
"logPath": "C:\\Logs",
"plainTextExtraction": {
"useCfs": false
},
"limitsForIndexedData": {
"maxFieldLengthKb": 1000000,
"maxTotalFileDataLengthKb": 1000000
}
}
- Click Save button two times (1. Focus to the button 2. Actual save) -> Now the logging is active
What is written to the log files
There are several files written for single indexing action. Below are the files from a simple metadata modification operation:
There are two meaningful filetypes in the set: .idx, .txt and .log. Idx files contain the actual content that is sent to the IDOL. The first and the larger is the actual indexed data of the object. The second one is the contents of modified IndexInfo, meaning the timestamp change for that object.
Txt files have REQ or RES in the filename. Those mean what commands and responses are being transferred between M-Files and IDOL. REQ also includes the content that has been indexed. RES mainly confirms that the addition was OK, but it also gives the INDEXID number that can be used for example when controlling the indexing queue. There are two sets of REQ and RES for indexing the actual content and its IndexInfo in _INTERNAL database.
NOTE1: Because the log files include the index content, the files might get very large if the amount of indexed material has been changed.
NOTE2: The log files are not deleted automatically. make sure to delete them manually or they will gradually bloat the disk.
