Tools → CMC Logs Manager
About the CMC Logs Manager
The Cluster Management Console (CMC) Logs Manager allows you to view, download, and summarize log files for all of the activities done in Incorta clusters.
CMC Logs Manager Access Rights
Only a CMC administrator can view the logs by selecting the Logs tab in the navigation bar of the CMC.
Types of Log Files
There are different types of logs:
Starting the 2023.7.0 release, Incorta has enhanced its logging framework in multiple aspect, such as, file naming, file size, and archiving. Currently, a log file is automatically zipped to incorta-<date>-<file_number>.log.zip when it reaches 1GB or when it reaches end of day.
The following is an example for the logging process on February 3rd, 2023:
● Incorta started logging events in `incorta.log` file with the start of the day.
● When the log file reached 1GB, Incorta zipped the current log file into `incorta-2023-02-03-01.log.zip` file.
● Incorta recreated another incorta.log file to continue logging events for the same day.
● By the end of the day, the second log file is zipped under the name: `incorta-2023-02-03-02.log.zip`.
With the new enhanced logging framework, Incorta retains the log files for 6 months only. To access older log files, please contact Incorta Support.
Service/Node Logs
The node log files are specific to a service or a node.
Such files contain logs for notifications, alerts, scheduled events, and synchronizations between the loader and the analytics services.
For releases prior to 2023.7.0, the log file name format in the CMC Logs Manager is:localNode_<service_name>_incorta.<date>.log.
For example, localNode_analyticsService_incorta.2021-03-23.log.
System Logs
The System log files are internal tenant log files that contain the startups and shutdowns logs.
You can find the Default Tenant Configurations page in CMC under Clusters > <cluster_name> > Configurations.
For releases prior to 2023.7.0, the System log file name format in the CMC Logs Manager is localNode_<service_name>_system_incorta.<date>.log. For example, localNode_analyticsService_system_incorta.2021-03-23.log.
Tenant Logs
The Tenant log files contain all of the activities done for a certain Tenant, such as login, loading schemas, and opening dashboards.
For releases prior to 2023.7.0, the Tenant log file name format in the CMC Logs Manager is: localNode_<service_name>_<tenant_name_>_incorta.<date>.log. For example, localNode_loaderService_tenant_incorta.2021-03-23.log.
Catalina Logs
The Catalina log files contain all of the activities in Tomcat server and all activities done outside of Incorta, such as APIs and .jar files.
For releases prior to 2023.7.0, the Catalina log file name format in the CMC Logs Manager is localNode_<service_name_>_catalina.<date>.log. For example, localNode_loaderService_catalina.2021-03-23.log.
SQLi Logs
The SQLi log files contain all of the interaction logs of a third-party tool with the analytics service database.
For releases prior to 2023.7.0, the SQLi log file name format in the CMC Logs Manager is: localNode_<service_name_>_sqli_incorta.<date>.log. For example, localNode_analyticsService_sqli_incorta.2021-03-23.log.
CMC Logs Manager Anatomy
The CMC Logs Manager consists of the following:
Context Bar
The context bar consists of two tabs:
- Logs, which contains all of the log files created.
- Logs Summary History, which contains summarized log files.
Search Bar
Logs Search Bar
The Logs search bar consists of the following fields that you can use to filter your search results:
| Control | Type | Description |
|---|---|---|
| Date | calendar | Specify a start and end date. |
| Cluster Name | drop-down list | Select a cluster name. |
| Service Name | drop-down list | Select a service name. |
| Tenant Name | drop-down list | Select a tenant name. |
| Get Files | button | Select get files to display log files based on the search criteria you selected. |
The Get Files button is disabled by default until you choose a cluster.
Logs Summary History Search Bar
The Logs Summary History search bar consists of the following:
| Control | Type | Description |
|---|---|---|
| Date | calendar | Specify a start and end date. |
| Cluster Name | drop-down list | Select a cluster. |
| Get Files | button | Select get files to display all summary log files based on the search criteria you selected. |
Use these fields to display the Logs Summary History fields for a specific date range, that cannot be more than one month, or a certain cluster.
List View
The list view for Logs and Logs Summary History are different from each other. The Logs list view displays the individual log files based on your search criteria.
The Logs Summary History list view displays a list of Log Summary files. You must first create a Log Summary to view the Log Summary History list.
Logs List View
By default, the Logs list view is empty and the Get Files button is disabled.
When you specify the search criteria and select the Get Files button, the CMC Logs Manager displays a list of all of the log files based on your search criteria.
To sort the logs by a column value in either ascending or descending order, select the column header.
For the Logs tab, the list view consists of the following properties:
| Property | Control | Description |
|---|---|---|
| Select All | check box | A header control to select all log files in the list. |
| Date | text | The date when the CMC logs manager created the log file. |
| File Name | text | The name of the log file. The file name is usually composed of the cluster name, service name, service type, tenant, log type, and the file creation date. |
| Service Name | text | The name of the service that performed the action for which the CMC created the log file. It can be either loader or analytics. |
| Service Type | text | The type of the service that performed the action. The service type can be either loader, analytics, or service. |
| Service Type Filter menu | drop-down list | A drop-down list that contains all of the service types. Use this drop-down list to display only the log files for a certain service type. |
| Tenant | text | The name of the tenant that the log file belongs to. |
| Logs Type | text | The type of the log file. There are different log file types, such as Incorta, tenant, and catalina. |
| Logs Type Filter menu | drop-down list | A drop-down list that contains all of the available file types in your search result. Use this drop-down list to display only the log files for a certain file. |
| File Size | text | The size of the log file that can either be in bytes, kilobytes, megabytes, or gigabytes. |
| Page Number | link/buttons | A numbered list of pages that exists with next and previous buttons. |
Logs Summary History List View
By default, the Logs Summary History list view is empty. Yet, the Get Files button is enabled as you can view the summary logs for all clusters.
When you select the Get Files button, the CMC Logs Manager will display a list of all of the logs summary history. To sort the logs by a column value in either ascending or descending order, select the column header.
For the Logs Summary History tab, the list view consists of the following properties:
| Property | Control | Description |
|---|---|---|
| Date | text | The date when you created logs summary history file. |
| File Name | link | A clickable name of the log file. The file name is usually in the following format: Logs_Summary_<timestamp>.log. |
| Cluster Name | text | The name of the cluster that performed the action for which the CMC created the log file. It can be either loader or analytics. |
| Download As | button | Two buttons. Each indicates the file type that you can download and save the logs summary history file to. The types are csv and json. |
| Page Number | link/buttons | A numbered list of pages that exists with next and previous buttons. |
Action Bar
The action bar only exists in the Logs tab and it consists of:
- The Actions button. This button is always disabled until you select at least one log file.
- Number of file(s) you have selected in the list view.
The Actions button opens the Actions menu that contains two options: Download and Summarize.
The Download option enables you to save the file to your local machine. While the Summarize option enables you to create a summary file for several log files.
CMC Logs Manager Actions
Using the CMC Logs Manager, you can perform the following actions:
- Search the log files
- Sort and filter the log files list
- Download log files
- Summarize log files
- Download a summarized log file
Search the Log Files
Logs
In the Logs tab, to search for the log files you must do the following:
- Select a date range.
The date range cannot be more than five days span.
- Choose a cluster.
- (Optional) Choose a service.
- (Optional) Choose a tenant.
- Select Get Files.
Logs Summary History
In the Logs Summary History tab, to search for the summarized log files you must do the following:
- Select a date range.
The summary history files can be kept for only one month.
- (Optional) Choose a cluster.
- Select Get Files.
When you select Get Files, the CMC displays a list of all of the created log files according to the specified search criteria.
Sort and Filter the Log Files
In the Logs tab, you can sort the list of log files in ascending or descending order according to:
- File creation date
- File name
- Service name
- Node name
- Service type
- Tenant
- Log type
- File size
Also, you can filter the list with respect to the service type and the logs type.
In the Filter menu, you can select OK to apply the filter or select Reset to clear any filtration applied.
Download Log Files
In the Logs tab, select one or more log files to download. After viewing the log files in the list view, do the following:
- Select one or more log files.
- In the Action bar, select Actions, and then Download.
The CMC downloads a zipped file named logs_incorta.zip to your local machine. This file contains all of the logs you have selected to download.
You cannot download files whose size is more than 1GB.
Summarize Log Files
In the Logs tab, you must select more than one log file to summarize. If you selected only one file and tried to summarize it, an error message will appear on the screen:
[403] Cannot Summarize.
There are several file types that you can summarize, such as mySQL, Incorta, and Oracle.
You cannot summarize Catalina files or files that have a size that is more than 1GB.
- Select more than one log file.
- In the Action bar, select Actions, and then Summarize.
You can cancel the summarize process by selecting the cancel button from the Action bar.
- Go to the Logs Summary History tab.
- Select Get Files.
The CMC created a new file that summarizes all of the log files you have selected earlier.
You can only run one summarization process at a time.
Logs Summary History File Details
In the Logs Summary History tab, and after you selected the Get Files button to display all of the available summary files, when you select the file name, a Log Summary pop-up window appears.
The log summary pop-up window displays two tabs:
- Entity Mode, which groups the log summary per entity.
- Service Mode, which groups the log summary per service.
Each tab contains a tree-based view for the entities and for each entity details.
Download Logs Summary History File
In the Logs Summary History tab, you can download the summary file as .csv or .json.
- Select Get Files
- Select csv or json from the Download As column.
The CMC downloads a .zip file to your local machine. This file contains the summarized logs either in .csv or in .json format.