Skip to main content
tiCrypt 2.18.1

System Services

Prerequisites

User Role:

Super-admin

System Services is the Management table that lists tiCrypt's backend services and shows whether each one is running. From it, a Super-admin can read a service's logs and configuration and restart the service. It is not the audit trail: service logs record what a service did and what went wrong, while Audit Logs record what users did.

The following table describes the columns of the System Services table.

ColumnDescription
NameThe display name of the service.
ServiceThe service's system name, ticrypt-<id>.
RunningWhether the service answered a status check within one second.
DescriptionWhat the service is responsible for.

The table always has nine rows: ticrypt-auth, ticrypt-file-manager, ticrypt-maintenance, ticrypt-proxy, ticrypt-stats, ticrypt-vm, ticrypt-logger, ticrypt-notifications and ticrypt-rest. The maintenance row shows the status of ticrypt-auth, which runs the maintenance tasks.

View Service by System​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. View all system services in the list.

View System Service Logs​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to view logs.
  5. Click the View logs button in the top right panel.
  6. In the View logs for ticrypt-<id> pop-up, set Since (days) and Until (days).
  7. Click Get Logs.
  8. Review the logs. Each line shows its Type, Timestamp and Message.
  9. Click Close.
Result: The pop-up lists the service's log lines for the chosen period, or "No logs found within the search parameters." if there are none.
note

The pop-up opens empty. No logs load until you click Get Logs.

Suppress MongoDB Error Messages in Front-End Logs​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to suppress MongoDB error messages.
  5. Click the View logs button in the top right panel.
  6. In the pop-up, tick the Suppress MongoDB error messages option. It is ticked by default.
  7. View the logs without the MongoDB error messages.
  8. Click Close.
Result: MongoDB error messages are hidden from the list and from a download. Untick the option to show them.

Refresh Logs​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to refresh logs.
  5. Click the View logs button in the top right panel.
  6. In the pop-up, click the Get Logs button on the right.
  7. Click Close.

Set a Logs Timeline​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to set the logs timeline.
  5. Click the View logs button in the top right panel.
  6. In the pop-up, under Since (days), enter how many days back the period starts. The default is 1.
  7. Under Until (days), enter how many days back the period ends. The default is 0 (now).
  8. Click Get Logs.
  9. View the logs for the specified period.
  10. Click Close.
Result: The pop-up lists the log lines between the two points in time.
note

Both values are whole numbers of days from 0 to 65535. Get Logs is disabled while Since (days) is smaller than Until (days).

Download System Logs​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to download system logs.
  5. Click the View logs button in the top right panel.
  6. In the pop-up, click Get Logs.
  7. Click Download.
Result: The lines shown in the pop-up are saved as a .log file named after the service. Download is disabled while the list is empty.

View System Service Configuration​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to view configuration.
  5. Click the View config button in the top right panel.
  6. In the View config for <service> pop-up, view the service configuration from the backend.
  7. Click Close.

Download System Service Configuration​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to download configuration.
  5. Click the View config button in the top right panel.
  6. In the View config for <service> pop-up, view the service configuration from the backend.
  7. Click Download.
Result: The configuration is saved as a .conf file named after the service.

Restart a System Service​

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service to restart.
  5. Click the Restart button in the top right panel.
  6. In the Restart <id> service? pop-up, which warns "Restarting services can be very disruptive to users. Please use with care.", click Yes.
Result: The service restarts. You can restart one service at a time: Restart appears only when exactly one service is selected.
warning

Restarting a system service may disrupt all users' workflows. Use this option carefully.

Export System Service(s) in CSV Format​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service(s) you want to export in CSV format.
  5. Click the Export CSV button in the top right panel.
  6. Select Selected items.
  7. In the local window, click Save.

Export System Service(s) in JSON Format​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Select the system service(s) you want to export in JSON format.
  5. Click the Export JSON button in the top right panel.
  6. Select Export selected items.
  7. In the local window, click Save.

Refresh System Service(s)​

bulk-action

  1. Go to the Management icon in the top left taskbar.
  2. Navigate to the Miscellaneous section.
  3. Click the System Services in the left panel.
  4. Click the Refresh button in the top right panel. You do not need to select a service.
Result: The Running column shows each service's current status.
tip

Click the Refresh automatically button, or press and hold Refresh, to keep the table refreshing on its own. Click it again to stop.

Related