Aspire Index Auditing is a feature aimed to help administrators keep track of all content source actions and search engine indexes in order to identify possible differences and problems between both of them.

Index Auditing consists of three components:

  • Content Source auditing
  • Search Engine index auditing (publisher index dumps)
  • Reconciliation file between the content source and search engine auditing files

 

On this page:

Training Material

If you're interested in learning more, here's a recording of the Tech Talk on the Performance and Auditing Tech Talk along with the Performance and Auditing Tech Talk presentation.

Content Sources Auditing

By default, every content source will log every action done for each of the documents crawled, to disable it go to the Advanced Connector Properties in the content source configuration and uncheck the Enable Auditing option.

 

There are 2 types of events logged:

  • Job
    • Indicates an event for one single job
  • Batch
    • Indicates an event for a batch of jobs

 The actions logged by the auditing are:

  • Add: 
    • The document was sent to be processed to the workflow as an add
  • Batch Completed: 
    • The processing batch finished successfully
  • Batch Error: 
    • The processing batch finished with error
  • Excluded: 
    • The document was excluded by index pattern configuration, no further processing was done for it
  • Update: 
    • The document was sent to be processed to the workflow as an update
  • Delete: 
    • The document was sent to be processed to the workflow as a delete
  • No Change: 
    • The document was found as not changed, no further processing was done for it
  • Workflow Complete: 
    • The document finished the workflow successfully
  • Workflow Error: 
    • The document finished the workflow with an error
  • Workflow Terminated: 
    • The document was terminated by a workflow rule
  • Crawl Begin: 
    • Indicates the beginning of the crawl process
  • Crawl End: 
    • Indicates the ending of the crawl process

 

How to access the Auditing

Step 1

To see the audit logs of any crawls from the Aspire UI, open the content source statistics, and click View Audit Logs:

 

Step 2

After you click on View Audit Logs, the following page will be displayed:

 

 

Step 3

You can filter the audit logs by type and/or action.

By Type

By Action

Search Engine Index Auditing

The auditing log files for a search engine are generated via index dumps. Only these publishers are able to create index dumps:

  • Publish to Solr
    See the tutorial on how to configure the index dump at Solr Tutorial.

  • Publish to ElasticSearch
    See the tutorial on how to configure the index dump at ElasticSearch Tutorial.

  • Publish to GSA
    See the tutorial on how to configure the index dump at GSA Tutorial.

To dump an index and compare it you have to:

  1. Select the publisher (should be configured to create index dumps) and click on Compare to:
  2. Go to any auditing page of a content source, and click on , 

  1. It will open a pop-up window for generating both index dumps and reconciliation files
  2. Click on Start Dump to start an index dump. Take into account that the index dump will be executed against the documents indexed by this content source only.

  1. You will see the dump state getting refresh by clicking on the refresh button, and once it finish you will see it in the dumps dropdown list:
  2. Select the index dump you have just created (notice the button action changes when you select an index dump) and click on Start Comparison
  3. When the comparison finishes you are going to be able to see the reconciliation file:

 

Auditing files

All publisher and content source audit files are located at {aspire-distribution-home}/audit.

  • The reconciliation audit files, once created, will be located under the folder named: {content-source-name}_{publisher-name}_diff
  • Each content source, publisher, or reconciliation folder under the audit folder can contain multiple audit files each identified by a timestamp:
  • For content sources audit files, the timestamp is the crawl start time.
  • For publishers and reconciliation the timestamp is the time of the audit file creation.

  • No labels