Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Once you have data has been ingested data into the system using Source Builder, you can run queries against the data ISA platform, Searches can be performed to return IKANOW Threat Analytics documents.  The documents include entities, associations, as well as geo/temporal data which can then be visualized.

Info

Data sources are associated to Data Groups and Users and User Groups at source creation time.

Searches are run within the context of a Project, which brings together Data Sources, Data Groups, as well as Users and User Groups.

Start by entering a query into the Threat Analytics query bar 

Image Removed

The search results are returned to the Project Workspace.

Image Removed

Documents or Records. For information related to the difference between Documents and Records please see below.  

Global searches return results for all the Data Groups to which you have been assigned access by an administrator.  Project searches are limited to the Data Groups assigned at the Project level.

About Documents and Records

You can query the Information Security Analytics platform using the query bar, as displayed below.  When querying the platform you can choose to display either documents or records. This will depend on the type of data comprised by your data sources.

Documents: The Information Security Analytics document is a representation of the source data after it has passed through the various stages in the source pipeline: Ingest, Transform, Enrich, and Output. Documents contain their own fields as well as sub-objects such as entities, associations, metadata, and query enrichment. This format is good for viewing structured and unstructured data such as "office-style" documents, web pages, RSS feeds etc.

Records: Records are a lighter weight Information Security Analytics object format for storing logs, term/record volumes or statistics. A very common use case for logs/records. When you query the platform with records selected, the output is visualized using Kibana.

Querying the Sources

Once you have created a Project and associated the Data GroupsUsers and User Groups, and Data Sources, you can run searches within your Project Workspace.

To query the Project Data

  • Ensure that you are within the desired Project, by referencing the selected project at top left of the interface.  To change to a new project, see the procedure below.
  • Provided you are in the correct Project, enter

    Searches. Searches return results for all the Data Groups to which you have been assigned access by an administrator. When selecting My Workspace, a search will apply to all of the data associated with that user.

    To query the Project Data

    1. Select either Documents or Records.
    2. Enter your search term into the Search bar and click Enter.  Any applicable documents are returned to the interface, corresponding to your query terms.

    Image Added

    The display of the Search results varies based on internal and external sources.

    Documents:

    Image Added

     

    Records:

    Records are displayed in Kibana.

    Image Added

    Anchor
    select a project
    select a project
    Selecting a Project

    To limit a search within the context of a specific Project, you need to select the Project.

    To select a project

    1. From the Threat Analytics interface, click Click on the name of the current project at top left.
    2. Find the project Project of choice in the dropdown menu.
    3. Select the projectProject.  You You are taken into the new Project workspace, and your search results, as well as any open visualizations are updated accordingly to reflect the data in the Project applicable Data Groups.

    Advanced Search and Filtering

    When you run queries against your data sources, it is possible to use Advanced Search, for advanced filtering capabilities.  Filtering enables you to narrow your results by applying constraints around Entities, Tags, Verb categories, and Weightings.

    Image RemovedImage Added

     

    To use the advanced query builder

    1. From the Search results, click on Filter Results.  It is also possible to access the settings by clicking Advanced Search next to the Search bar.

    Configure the filters, as described in the table below.  Based on the various settings, the search results are filtered accordingly.

     

    FilterDescription
    Entities

    Search results can be easily filtered by entity type so that only documents including those entity types are returned to Dashboards, score cards etc.

    Possible values:

    • People
    • Places
    • Organizations
    • Associations
    • Other
    Tags

    When sources are added to the platform, tags can be applied. These tags can then be used to limit a query to a subset of documents within a Project based on document tags.

    Verb Categories

    You can filter returned associations by using verb types. For example, you can only return associations with the verb category "travel," to encompass associations with verbs such as "flew" and "drove".

    Possible verb category filters are populated by the platform.

    Weightings

    In scoring, weightings enable you to further alter query output results.  For example, you can set a central point in time, around which results are promoted. For more information see below.


    2. Click on on Run Search. 

    The advanced query is executed against the sources and the results are returned.

    Anchor
    half-life
    half-life
    About Weight by Time Decay:

    You can set a central date (date and time) around which results will be promoted.  Results Results after that central point in time are demoted as per the half-life setting.

    Half-Life Setting Example:

    1m (one month) time decay -  results results within 1 month of the entered date are promoted to top of results; results between 1 to 2 months from decay time are halved; results 2 to 3 months from decay time are quartered, etc. 

    Saving and Loading Advanced Queries

     You can save useful queries for re-use.

    Exporting a Query

    todo

    Importing a Query

    todo

     

    Reports and Buckets

    About reports and buckets

    Adding Documents to a Report

    To add documents to a report

    Adding Documents to a Bucket

    To add documents to a bucket

    Panel

    In this section:

    Table of Contents
    maxLevel2
    indent16px

     

    Panel

    Related Documentation:

    Search Interface