Adapters Fetch History
  • 28 May 2023
  • 7 Minutes to read
  • Dark
    Light
  • PDF

Adapters Fetch History

  • Dark
    Light
  • PDF

Article Summary

The Adapters Fetch History page allows users to view fetch results over time for each adapter and connection. It displays data such as adapter name, status, instance, connection label, start and end times, duration, total devices/users fetched and ignored devices/users. Filters can be applied to the table to create queries which can be saved for later use. The page also allows users to terminate a fetch process if it is taking too long. Finally, the page always displays the last 100000 activities.

Use the Adapters Fetch History page to review the fetch results over time for each adapter and for specific adapter connections.

To open the Adapters Fetch History page, click image.png icon on the left panel.
In the Adapters page, click Adapters Fetch History.

FetchHist1.png

You can also open the Adapters Fetch History page from a specific adapter. In this case the Adapters Fetch History will be filtered on the specific adapter.
When there are no connections defined for an adapter, the Adapters Fetch History button isn't available on the specific adapter page.

Viewing Fetch History Data

Use this page to view Adapters Fetch History for any fetch action performed in the system, whether it is part of the Discovery Cycle, Manual or Custom Scheduled.

AdapterFeetchHistroyUp5

The data is displayed for each fetch action and is auto-refreshed based on the auto-refresh rate definition.

If a specific adapter has only an inactive connection, or the adapter never fetched data, the specific adapter is not displayed in the adapters filter.

The following columns are displayed for each fetch action:

  • Adapter Name - The adapter which fetched the data - Filterable column.
  • Status - Presents the fetch status - Filterable column.
    • Contains the following values:
      • Fetch started - The fetch process was initiated.
      • Fetch ended successfully - The fetch ended successfully with no errors, and results are presented.
      • Fetch ended with errors - The fetch ended but there was one or more errors.
      • Fetch failed - The fetch process failed.
      • Connection failed - There was a connection error for the specific connection.
      • Fetch skipped - When there is a Tunnel configured, and the Tunnel status was disconnected.
      • Fetch terminated - The fetch process was terminated by the user.
  • Fetch Events - The number and type of Fetch Events. The type of events are indicated by a color that indicates the severity. Mouse over to see how many of each event type. Click on this column to open the Adapter Fetch Events page filtered by the specific fetch for the adapter.
  • Instance - The specific instance the adapter and connection were initiated from.
  • Connection Label - The connection label (if configured)
  • Connection ID - The connection ID.
  • Start Time - The fetch process start time - Filterable column.
  • End Time - The fetch process end time - Filterable column.
  • Duration - The calculated total fetch duration, in HH:DD:MM format.
  • Total Devices - The number of nonunique total devices fetched.
  • Ignored Devices - The number of devices that were not seen by the source in the last X hours (X is defined in Adapter Advanced Settings).
  • Total Users - The number of nonunique total users fetched.
  • Ignored Users - The number of users that were not seen by the source in the last X hours (X is defined in Adapter Advanced Settings).
  • Discovery Cycle - The identifier of the discovery cycle in which the activity occurred. This is presented as the start date and time of the discovery cycle.
  • Last Connection Update - Shows if the adapter or the connection configuration were updated since the last fetch. The field will either show Yes or No. If the connection was updated, Yes is a link that opens the Activity Log page filtered to the change made, displayed by the start date of the previous fetch start time. The Message column shows details of the old configuration and the new configuration, mouse over to see them, or Export to CSV.
    • Connection update can be:
      • Configuration change to the adapter connection itself.
      • Configuration change on the adapter level that affects the connection, for instance if the connection is not customized and ignores an adapter configuration change.
  • Installed Version - The Axonius installed version at the time the fetch was initiated. This is the value that is displayed in “About” under System Settings.
  • Error Details - The details of errors - displayed when the status is Connection Failed or Fetch Failed.

Changing the Order Columns are Displayed

You can change the order of columns displayed.
Drag and drop columns on the table to arrange them in the order you want. The changes are only for the current session.

Terminate Fetch

Sometimes the Fetch process might take a long time, and you therefore want to stop the Fetch process of an adapter connection.
To stop the Fetch process

  1. From the Adapter Fetch History page select the adapter or adapters that you want to stop. The Actions menu is available.
  2. Click the Actions menu and select Terminate Fetch.

TErminateFetchADapN.png

The system terminates the fetch process of the adapter connections selected if they are in the middle of the fetch process.

A message is displayed in the Adapter Fetch History pane showing that the adapter fetch was terminated.
FEthcTerm2N.png

Note:

Terminate Fetch only stops the current Fetch process. If you do not want this adapter connection to be fetched in the future, you need to set the adapter as inactive in the Adapter page

You can see which adapter connections were terminated by filtering by Fetch Terminated in the Fetch Status dropdown.

Filtering

  • You can filter on the values to be displayed in the table. You can then use the filters to create queries based on the filters and also save them as queries which can be used later on. Read more about queries based on filters.

  • The following filters are available:

    • Adapter Name - To view the fetch history of a specific adapter.

    AdapterFetchDrip.png

    • Instance - Show only fetch history from a specific instance

    • Fetch Status - Display only fetch history with a specific status.

      FetchStatus.png

    • Connection Name - Display only fetch history from a specific connection. The values of the filter are either the connection label (when set for a connection) OR connection ID.

    • Total Users - From the dropdown, select an operator (Equal to, Greater than, Less than) and enter the number of total users that you want to filter.

    • Total Devices - From the dropdown, select an operator (Equal to, Greater than, Less than) and enter the number of total devices that you want to filter.

    • Fetch Date Range - You can filter for specific fetch data by date with the date range picker or by a specified last number of days, weeks, months, or years or for a time range prior to the number of days set.

    To filter by date range:

    1. From the Time Range dropdown, select In range.
    2. Select Start date and End date to indicate the date range to display results. 
    3. To filter results only for a specific date, select the same date twice.
    4. If you want to include specific times in the date range, click Select Time in the date range picker.
    5. Click OK to set the Time Range filter.


    DateRange

    To filter by the last number of days, weeks, months, or years:

    1. From the Time Range dropdown, select Last and specify a value in the field next to Last.
    2. By default, the value is the number of days. If you want to filter by weeks/months/years, select the relevant option from the days dropdown.

    TimeRange


    To filter by the number of days ago:

    You can set a Time Range to show only the events prior to the number of days, weeks, months etc set.

    1. From the Time Range dropdown, select Prior to. 
    2. In the number field enter a value or use the arrows to select the value you want.
    • By default, the value is the number of days. If you want to filter by weeks/months/years, select the relevant option from the days dropdown.

    DurationPrior


  • Duration - From the dropdown, select an operator (Equal to, Greater than, Less than) and enter the time duration (in HH:MM:SS) format) that you want to filter.
    Duration

    • To set seconds, highlight SS and enter a number, up to 59 seconds.
    • To set minutes, highlight MM and enter a number, up to 59 minutes.
    • To set hours, highlight HH and enter a number, up to 99 hours.
  • Discovery Cycle - Display only fetch history from a specific Discovery Cycle, or Cycles.

  • Click Clear All to clear all selections in a specific filter.

  • Click Reset from the top of the Adapters Fetch History page to clear all filters and display the entire fetch history.

    New Query_AdapterFetchHistory

  • Hide Realtime Adapters Data - If there is an adapter configured for real-time fetch, when switched on, the real-time related fetch history is hidden.
    image.png

Saving Filters and Searches

You can save filters and searches you configure on this page as Queries, Refer to Creating Queries Using Filters for full details. Once you save a query, you can see it on the Queries page.
Use:
Save As - to save the filters/search as a Query
Reset - to reset the display

By default, 50 rows are displayed in each table page. Click the appropriate icon on the bottom left side of the table to change the number of rows per page; choose between 20, 50 or 100. image.png
Use the pagination bar on the bottom right side of the table to move between pages: image.png

Adapters Fetch History Retention

The Adapters Fetch History page always displays the last 100,000 activities.



Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.