×
×
×
×

Support Log Upload

To ensure a smooth log upload process for customers whenever an issue occurs on their endpoint for troubleshooting and analysis, a new feature called "Upload Logs" has been introduced in Endpoint Central. With the introduction of this new feature, you no longer need to manually collect log files from each user device when an issue arises. Instead, you can go to the Endpoint Central web console and report the issue you are facing. A ticket will be automatically created and linked to the issue you have described.

After that, you can choose the type of issue you are facing from a list of predefined issues, each with templates carefully tailored to common scenarios in Endpoint Central. The log files relevant to the selected issue will be automatically chosen for upload. You can also specify which devices (endpoints) were affected by the issue. This feature allows you to track the log upload in real time and check whether the raised ticket has been resolved.

This new feature also saves time for customers who need to submit log files from all affected devices, making it a hassle-free experience for any user facing an issue.

Log Upload Mechanism

Logs can be uploaded manually and automatically from the console. The key point to understand here is logs can also be uploaded directly from endpoints where the issue has occurred or from the console where the target endpoints can be mentioned in which the described issue has occurred.

Automatic upload of logs

Prerequisites

If you have configured a proxy server, make sure to whitelist the below mentioned domains:

bonitas.zohocorp.com and creator.zoho.com and bonitas.zohocorp.eu (if you are from the EU region)

Please click here to know more about all the domains that need to be whitelisted.

To know more about configuring a proxy server, click the link here.

To upload logs from the product automatically

Automatic upload selects the logs relevant to the issue type you choose and uploads them directly from the web console to the Zoho Bonitas server.

  1. Open the Endpoint Central web console → Navigate to Support → Upload Logs
  2. You will be navigated to the Issue Summary page. Here, click Upload Logs and select the Automatic Upload option.
  3. Enter the Contact Email ID and Ticket ID.
Note
If you have a ticket ID related to the issue you're currently facing, you can enter it. If this is your first time facing the issue and you don't have a ticket ID, you can skip this option, and a new ticket ID will be generated for you.
  1. Describe the issue.
  2. Select the issue type and you'll see a list of all the logs that will be uploaded.
  3. Define Target. Enter the details specific to the logs you have uploaded. These are the following details that need to be entered:
    • For Web console logs, choose the HAR logs to be uploaded followed by console logs. Refer to Uploading HAR files and console logs.
    • For Agent logs, select the computers where the issue has occurred.
    • For MDM agent logs, select the mobile devices where the issue has occurred.
    • For Distribution Server logs, select the remote offices where the issue has occurred.
    • For Configurations logs, select the configuration PDF's where the issue has occurred.
Note
If the Agent/Distribution server is not reachable, the logs will be uploaded once communication between the Agent/Distribution Server and the Server is restored.
  1. Attach additional files if required and give user consent. You can attach images or videos in the following supported formats: TIF, PJP, APNG, XBM, JXL, SVGZ, JPG, JPEG, ICO, TIFF, GIF, SVG, JFIF, WEBP, PNG, BMP, PJPEG, AVIF, PDF, MP4, AVI, MOV, MKV, FLV, WEBM, WMV, MPEG, M4P, and M4V.
  2. Click Upload Logs and all the logs will be uploaded to the server. Click Upload logs again to give confirmation. You can track each upload under Log Upload Status.
Endpoint Central web console showing the Support menu with Upload Logs option highlighted
Issue Summary page with Automatic Upload option selected
Upload Logs form showing issue type selection and log file list
Navigate to Support > Upload Logs

Manual upload of logs

Manual upload lets you add the log files yourself and upload them to the Zoho Bonitas server. If you cannot open the web console on the server, collect the server logs and upload.

  1. Open the Endpoint Central web console
  2. Navigate to Support → Upload Logs
  3. Click Upload Logs again and select Manual upload
  4. Select the product name
  5. Enter the Ticket ID and password
  6. Select the modules where you're experiencing the issue.
  7. Specify your email address
  8. To receive notifications, please provide an email address where you would like to be notified
  9. Add any comments if required
  10. Click add files to add new files
  11. Click Upload
  12. Select files for log analysis, debugging, and migration
  13. Alternatively, you can also send the logs manually to the support team directly. To know more, visit this link.
Endpoint Central web console showing the Support menu with Upload Logs option highlighted
Manual Upload option selected on the Upload Logs dialog
File selection screen for manual log upload
Navigate to Support > Upload Logs

Configuring Log Upload Settings

To configure log upload settings, follow the steps mentioned below:

  1. In the Endpoint Central server web console, navigate to Support > Upload Logs. The issue summary page will be displayed. On the top right corner of the page, click Log upload settings.
  2. Enable Automatically Upload Live Logs to Zoho Bonitas Server to automatically upload live logs to the Zoho Bonitas Server until a configured time. This ensures that up-to-date logs are continuously made available to the support team, enabling faster and more accurate diagnosis and significantly improving the overall troubleshooting experience. (See Automatically Upload Live Logs to Zoho Bonitas Server below for details.)
  3. Select the option to allow endpoints with internet accessibility, including agent machines, Secure Gateway Server, and Distribution Server, to directly upload log files to the support team for faster analysis and resolution.
  4. Select the option to restrict bandwidth usage for log uploads, if you want to set restrictions for bandwidth consumption while uploading logs.
  5. You can also select the retry interval for failed log uploads.
  6. Finally you can also configure Log Cleanup Settings to clear resolved logs/issues after a configurable number of days automatically. You can only clear up issues from the console, when they are marked as resolved. To do so, navigate to Support → Upload issues → Issue Status and finally mark the issue as resolved.
  7. Click Save.
Endpoint Central web console showing the Support menu with Upload Logs option highlighted
Log Upload Settings page showing configuration options
Log Cleanup Settings configuration panel
Navigate to Support > Upload Logs

Automatically Upload Live Logs to Zoho Bonitas Server

The Automatically Upload Live Logs to Zoho Bonitas Server option lets you upload live logs to the Zoho Bonitas Server continuously for a defined period of time. Instead of manually collecting and uploading logs every time an issue is reproduced, you can enable this option so that logs are uploaded to the server automatically until a configured end time. This is especially useful when working with the support team on an intermittent or difficult-to-reproduce issue, as the relevant logs are already available on the server as soon as the issue occurs.

Note
The Automatically Upload Live Logs feature is supported only from Endpoint Central build version 11.5.2632.01

How it works

When this option is enabled and saved, live logs are uploaded continuously to the Zoho Bonitas Server from the moment you save the setting until the Upload Log until time you specify. Once that time is reached, the upload stops automatically — no further logs are uploaded until you enable the setting again.

Configuring live log upload

  1. Select the Automatically Upload Live Logs to Zoho Bonitas Server checkbox.
  2. Note
    Distribution Server(s) logs will not be streamed if no customer is selected.
  3. In the Upload Log until field, specify the date and time up to which logs should be uploaded. Use the MM/dd/yyyy, HH:mm format (24-hour clock).
  4. Click Save. The upload begins immediately and continues until the configured time.

Reference ID

Once the option is enabled and saved, a unique Reference ID is generated and displayed on the settings page. This ID uniquely identifies the logs that are being uploaded to the Zoho Bonitas Server for your environment. When you contact the support team, share this Reference ID with them so that they can promptly locate and access the corresponding logs, enabling them to analyze and resolve your issue more efficiently.

Stopping log upload

The live log upload stops in either of the following ways:

  • Automatically at the configured time — When the configured Upload Log until time is reached, the upload stops automatically and no further logs are uploaded.
  • Manually — Clear the Automatically Upload Live Logs to Zoho Bonitas Server checkbox and click Save. The upload stops as soon as the change is saved, even if the configured time has not yet been reached.

Extending the upload period

If the upload period has expired and additional logs are required, you can extend it. Set a new, later date and time in the Upload Log until field and click Save. The live log upload resumes and continues until the newly configured time.

Supported logs

To see the exact set of logs that are included, click the info (?) icon next to the option on the settings page, which lists the supported logs.

Log Upload Settings page showing configuration options
Live log upload settings with Upload Log until field highlighted
Reference ID displayed after enabling live log upload
Navigate to Support > Upload Logs

Uploading logs directly from endpoints

Logs can be directly uploaded from agent machines using the agent tray icon when there is no central server accessibility.

If you have internet connectivity but cannot access the Central Server, follow the steps mentioned below:

  1. Go to the Agent tray icon on your endpoint and navigate to Agent Troubleshoot > Upload logs.
  2. The Upload Logs Summary will be displayed. Click Upload Logs.
  3. Enter the contact Email ID
  4. Specify the Ticket ID
  5. Describe the issue
  6. Select the Issue Type
  7. Tick the User Consent checkbox
  8. Click Upload Logs.
Agent tray icon context menu showing Agent Troubleshoot option
Upload Logs Summary dialog from the agent tray
Agent-side Upload Logs form with issue type and consent checkbox
Navigate to the Agent tray > Agent Troubleshoot > Upload logs.

If the agent machine is in a closed network, you can either archive and upload the logs or configure a proxy. The steps for each method are mentioned as follows:

If you want to archive and upload the logs manually, follow the steps mentioned below:

  1. Go to the Agent tray icon > Agent troubleshoot > Upload logs
  2. Click Upload Logs in the Upload Logs Summary dialog box.
  3. The user will be given two options: one to configure a proxy and another to manually upload the archived logs. Choose the Archive and Upload Logs Manually option.
  4. Select the issue type and click Archive Logs.
  5. The log collection process will be initiated.
  6. After the logs are archived, go to bonitas.zohocorp.com to upload the archived file.
  7. Select the product as Endpoint Central
  8. Specify the ticket ID, if you have received one previously for the specific issue you are encountering.
  9. Add modules and specify the Contact Email ID
  10. Explain the problem that you have encountered in a comment
  11. Proceed to upload the collected logs.
Agent tray icon context menu showing Agent Troubleshoot option
Upload Logs Summary dialog from the agent tray
Archive and Upload Logs Manually option selected
Issue type selection for archiving logs
File selection screen for manual log upload
Navigate to the Agent tray > Agent Troubleshoot > Upload logs.

If you want to upload logs by configuring a proxy server, follow the steps mentioned below:

  1. Go to the Agent tray icon on your endpoint and navigate to Agent Troubleshoot > Upload logs.
  2. The Upload Logs Summary dialog box will be displayed. Click Upload Logs
  3. Click the Configure Proxy option to upload the logs.
  4. Set up a proxy to connect to the Zoho Bonitas Server and select Proxy type as Configure Manually.
  5. Enter the Proxy Type
  6. Specify the HTTP Proxy Host and HTTP Proxy Port details
  7. Enter the Username and Password
  8. Click Save and the Proxy details will be saved successfully.
  9. Click Return to Summary
  10. Enter the contact Email ID
  11. Specify the Ticket ID
  12. Describe the issue
  13. Select the Issue Type
  14. Tick the User Consent checkbox
  15. Click Upload Logs.
Agent tray icon context menu showing Agent Troubleshoot option
Upload Logs Summary dialog from the agent tray
Configure Proxy option in the Upload Logs dialog
Proxy configuration form with host and port fields
Proxy credentials entry screen
Proxy saved confirmation and return to Upload Logs summary
Navigate to the Agent tray > Agent Troubleshoot > Upload logs.