Skip to main content

Traffic Log

The Traffic Log allows you to monitor the traffic logs of your FSI server(s) and/or traffic server(s). This page explains how to use the tool.

Traffic Log

Traffic Log Overview​

The Traffic Log provides three types of statistical data for each item. For connectors and folders, the numbers represent the total for all subfolders and items.

  • Hits: the total number of items served
  • Resource Hits: the total number of individual resources served (for example, if "example.tif" was served 10 times, Hits would be 10 and Resource Hits would be 1).
  • Traffic: the total traffic served from this folder or asset (the base is 1,000, e.g. 1 kB = 1,000 bytes)

Controls - drop down menu​

  • Collection: view traffic, hits and unique resource hits for the folders defined by your collection
  • Browse: allows you to browse through the FSI Server connectors and folder structure to view statistics for each folder and asset.
  • Top Asset Hits: shows a list of the most requested assets
  • Top Asset Traffic: ranks the assets that have generated the most traffic
  • Top 404 Requests: shows a list of the top requests that returned an HTTP 404 - Not Found response
  • Top HTTP Response Codes: shows a list of HTTP response codes sorted by number of hits
  • Top Host Hits: ranks the hosts from which the assets are served
  • Top Referrer: shows the top domains from which the assets are requested

Other controls​

  • Edit Collection: edit the JSON file used to create your collection
  • Export JSON: exports the currently displayed stats as JSON
  • Reload: clears the cache and reloads the data
  • Help: opens this help document
  • Month: use this selector to choose which month you want to check

Browse​

This section allows you to browse through all the Connectors, Folders and Assets that have been served during the selected time period. Note that this is similar to the content on your FSI Server, except that items that have not been served will be missing.

Traffic Log Browse

The blue bar at the bottom shows the total for the current view: The number of items displayed and the summary of hits, resource hits and traffic that has occurred for all of these items.

You can sort the items by any of the four columns by clicking on the corresponding column header.

Clicking on a connector allows you to browse deeper into the tree.

When you are at the file level, the hits and traffic for each file are shown - the resource hits field is empty as there is, by nature, only one resource causing the hits shown. The grand total in the blue bar at the bottom changes according to the folder currently displayed.

Traffic Log Browse File Level

You can go back to the upper levels by clicking on the corresponding pathname, or back to all connectors by clicking on the All Connectors field. You can also use the History Back button (in the toolbar or on your mouse) to return to the previous location.

If a folder contains more than 10,000 items, only the top 10,000 items and a note will be displayed. However, the total at the bottom will show the total number of items without any limit.

Collection​

Collections make it easy to create a report for groups of folders.

Traffic Log Collection

For example, if you have several customers whose traffic you need to monitor, you can group all the relevant connectors or folders into one section and easily see the amount of traffic associated with each customer.

Clicking on a connector or folder listed in a group automatically returns you to the Browse view.

Edit Collection​

Clicking on this button opens an editor where you can edit your collection in JSON format. An example of such a file is shown on the right.

Traffic Log Edit Collection

The first thing you need to do is declare the name of a group, then under paths you need to list the FSI server paths you want to add to the group as an array. You can add source connectors, but you can also add folders at a deeper level, such as catalogs/customer-b/.

Note:

To display the correct set, avoid duplicates in a group. For example, adding catalogues and catalogues/customer-b/ to the same group would result in an incorrect calculation, as the catalogues/customer-b/ folder would be included twice in the calculation.

You can optionally add subgroups to each group before adding the paths.

The indent icon formats the JSON data, while the line icon removes all whitespace. The Wrench icon fixes the JSON data by fixing quotes and escape characters and removing comments. The Code/Tree selector allows you to toggle the appearance of the editor between a normal code editor view and a tree view.

Click Save to save your changes to the collection and view the result immediately. Note that the JSON source for the collection is the same for each time period.

Edit Filter (Does not apply to third party customers)​

Edit Filter allows you to filter the traffic log results and restrict them to specific paths.

Traffic Log Edit Filter

This is useful if you want to give an external client access to your log data, or if you want to search for results from a particular connector or folder (e.g. to see the top 404 requests from a particular folder).

The filter is a positive list, so you need to list everything in the JSON that you want to include in an array.

For example: "includes": "all" shows everything, a filter might look like this "includes": [ "connector-a", "connector-b/folder-a", "connector-c/folder-a/imagexy.jpg"].

Note:

Positions in the array must be listed without slashes at the beginning or end of the position.

Export JSON data​

Click the Export JSON button to export the data currently displayed in the list to JSON format.

This allows you to use the traffic data in third-party applications.

Traffic Log Export JSON