FX Logs

Introduction

FX Logs displays an itemized sync history for your users.

The date times shown in FX Logs are in the UTC format.

UTC format in FX Logs

You can use FX Logs to monitor:

  • Overall sync performance including average sync time and sync success rate

  • Sync performance for on each device type, and on each operating system per specific users

Prerequisites

To use FX Logs, you need to:

Have these user licenses Have these permissions Complete these tasks
and review these topics
before continuing

Config FX Logs Custom Permissions

To use FX Logs within FieldFX, you need to specify the custom permissions.

  1. In your org, click Gear to access Setup.

  2. At Setup, enter permission in the Quick Find search box.

  3. Click Custom Permissions.

    1. Find Admin Tool - FX Logs in the list.

    2. If not,

      1. Click New.

      2. At the New Custom Permission screen, add Admin Tool - FX Logs if not already added.

        Label

        Admin Tool - FX Logs

        Name

        AdminTool_FX_Logs

        Description

        View sync use and data

    3. Click Save to finish and return to the list of custom permissions.

  4. Add custom permission to profile.

    1. At Setup, enter Apex in the Quick Find search box.

    2. Click Profiles.

    3. Find the profile you want and open it.

    4. In the list of Custom Permissions, find FX5.Admin Tool - FX Logs.

    5. Click Edit and ensure that the FX5.Admin Tool - FX Logs custom permission is checked.

  5. Apex Classes for the profile.

    1. At Setup, enter Apex in the Quick Find search box.

    2. Click Profiles.

    3. Find the profile you want and open it.

    4. Under Apps, scroll down to Apex Class Access and open it.

    5. Find OmnibusRestService in the list.

      OmnibusRestService may not be on the first page depending on the profile. Use the page tools to navigate to other pages.

Access FX Logs

Go to https://fxlogs.fieldfx.com and log in as a FieldFX administrator. In Admin Tools, click on FX Logs.

Date Controls

Use the date controls to change the dates and times analyzed in the metrics.

You can view data from the last hour up to the last 3 days.
Screenshot of the options for date controls in FX Logs
Figure 1. Use the selector to choose how far back to display log data

Back to Top

Statistics

With FX Logs, you can monitor the these statistics:

Overall Totals

Total number of syncs and total number of users who synced.
Screenshot of Sync Statistics
Figure 2. Sync Statistics display total syncs and total number of users

Sync Status

Sync success rate.
Example of a successfully completed sync
Figure 3. Sync Status displays the percentage of syncs completed

Sync Type

Percentage of each type of sync.

See the sync article for information on the different types of sync.
image
Figure 4. The percentage of syncs of each sync type

Mobile Version

Percentage of syncs on each version of FieldFX Mobile.

A user’s mobile version is defined in their User Profile.
Screenshot of the mobile version section of FX Logs
Figure 5. Percentage of syncs from each version of mobile

Operating System

Percentage of syncs in each operating system.
Screenshot of the Operating System section of FX Logs
Figure 6. Percentage of syncs originating from various operating system

Browser

Percentage of syncs in each browser.
Screenshot of the Browser section of FX Logs
Figure 7. Percentage of syncs from various Internet browsers

Device

Percentage of syncs on each type of device.
Screenshot of the Device section of FX Logs
Figure 8. Percentage of syncs from various types of devices

Back to Top

Sync History

With the Sync History, you can view information on three different tabs: Syncs, Slow Syncs Tab, and Error Messages Tab.

Tab Name Description

Syncs

Displays details for every sync during the specified range.

Screenshot of the Syncs tab
Figure 9. Example of the full Syncs tab

Hover over the icons on the left of each entry to view further details about that sync.

Screenshot of the hover popup for sync details
Figure 10. See more information about a sync by hovering over the icons to the left of a particular sync

Select a sync and a panel displays at the bottom of the page to show detailed information.

Screenshot of a particular sync’s details panel
Figure 11. Selecting a sync prompts a details panel to display on the bottom of the screen

Slow Syncs Tab

Displays details for every sync that took longer than 1 minute.

Screenshot of a sync with the Slow Syncs tab
Figure 12. If a sync took longer than one minute, an additional Slow Sync tab displays in the Sync Details panel

Hover over the icons on the left of each entry to view further details about that sync.

Screenshot of a Slow Sync’s hover popup
Figure 13. Display more details about a Slow Sync by hovering over the icons

Select a sync to view detailed information for that sync.

More details about using the information that displays are below.
Screenshot of the Slow Sync tab with a sync selected
Figure 14. The Slow Syncs tab also displays the Details panel when a particular sync is selected

Error Messages Tab

Displays the percentage of syncs that failed due to each error type.

Screenshot of the Error Messages tab selected
Figure 15. If error messages exist, the Error Messages tab displays

Select an error and then open the Syncs tab to view the syncs with that error.

Back to Top

Diagnosing Sync Issues

After selecting a sync, information about the selected sync displays in the bottom portion of the screen in the Sync, Alerts, or the Details Tab.

Screenshot showing a sync with multiple Sync details displaying
Figure 16. The bottom of the screen displays sync details when a particular sync is selected
Tab Name Description

Sync

Each sync request displays in the order in which it begins, summarized by the type of information in the request.

Example 1. Account object requests

Requests to Account object are summarized on the same row.

Each request has a The bar graph which shows the active and inactive sync times. Active times are in darker blue. Inactive times are in lighter blue.

Details

Displays more information about each active request in the order in which it is active.

Example 2. Active Request from the Account object

Each active request for information from the Account object appears on a separate line.

Pills give more information about the request. Hover over some pills for more details, such as the query used.

Alerts
Alerts give additional details to pay attention to

Screenshot of the Alerts tab in a Sync’s details

Summaries of potential problems that could be addressed to improve future sync performance.

Each warning type has information about potential solutions to address the alert.

Alerts are prioritized in these categories:

  • Critical: Requires immediate attention

  • Warning: Recommended issue for attention

  • Caution: Watch the item for possible future attention

Recommended Reading

Back to Top