Versions Compared

Key

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

...

Enable activity tracking in the Server Configuration (frontend.userapp.log-activity).

...

The activity logs are then by default stored under /var/log/squirro/frontend/$hostname/activity.$year-$month-$day.jsonl.

The path can be changed in the common.ini file by adjusting the path config in the activity section:

Code Block
[activity]
path = /var/log/squirro/frontend/

Activity Tracking Project

...

By setting up the source as 1-click connector, all necessary facets are automatically mapped correctly. If you need to map the facets manually, click the NEXT button (step 3 above). The relevant facets are listed in the facets.json below.For manually created monitoring projects, the Squirro Activity Log data loader plugin uses a custom index with name squirro_v9_${project_id}. The index is required to set up the popular queries suggestions.

Expand
titleSquirro Activity Log: facets.json
Code Block
languagejson
{
    "source_type": {
        "name": "source_type",
        "display_name": "Source Type",
        "default_value": "Activity",
        "visible": true,
        "searchable": true,
        "typeahead": true,
        "analyzed": true
    },
    "pageview_id": {
        "name": "pageview_id",
        "display_name": "Pageview",
        "analyzed": false,
        "typeahead": false,
        "group_name": "Activity"
    },
    "source": {
        "name": "event_source",
        "display_name": "Source",
        "analyzed": false,
        "group_name": "Activity"
    },
    "action": {
        "name": "action",
        "display_name": "Action",
        "analyzed": false,
        "group_name": "Activity"
    },
    "user_id": {
        "name": "user_id",
        "display_name": "User ID",
        "analyzed": false,
        "typeahead": false,
        "group_name": "User"
    },
    "query.query": {
        "name": "query",
        "display_name": "Query",
        "group_name": "Activity",
        "analyzed": true,
        "searchable": falsetrue
    },
    "item.id": {
        "name": "item_id",
        "display_name": "Item ID",
        "analyzed": false,
        "typeahead": false,
        "group_name": "Activity"
    },
    "item.link": {
        "name": "item_link",
        "display_name": "Item Link",
        "analyzed": false,
        "group_name": "Activity"
    },
    "drop_to": {
        "name": "drop_to",
        "display_name": "Item Dropped To",
        "analyzed": false,
        "group_name": "Activity"
    },
    "widget.type": {
        "name": "widget_type",
        "display_name": "Widget Type",
        "analyzed": false,
        "group_name": "Activity"
    },
    "dashboard.title": {
        "name": "dashboard_title",
        "display_name": "Dashboard",
        "analyzed": false,
        "group_name": "Activity"
    },
    "layer_title": {
        "name": "layer_title",
        "display_name": "Layer",
        "analyzed": false,
        "group_name": "Activity"
    },
    "dashboard.id": {
        "name": "dashboard_id",
        "display_name": "Dashboard ID",
        "analyzed": false,
        "typeahead": false,
        "group_name": "Activity"
    },
    "project.title": {
        "name": "project_title",
        "display_name": "Project",
        "analyzed": false,
        "group_name": "Activity"
    },
    "project.id": {
        "name": "project_id",
        "display_name": "Project ID",
        "analyzed": false,
        "typeahead": false,
        "group_name": "Activity"
    },
    "edit": {
        "name": "edit",
        "display_name": "Edit",
        "analyzed": false,
        "group_name": "Activity"
    },
    "microseconds": {
        "name": "microseconds",
        "display_name": "microsecondsMicroseconds",
        "data_type": "int",
        "group_name": "Activity",
        "typeahead": false
    },
    "result.start": {
        "name": "result_start",
        "display_name": "Result List Offset",
        "data_type": "int",
        "group_name": "Activity",
        "typeahead": false
    },
    "result.total": {
        "display_name": "Resultsresult_total",
        "display_name": "result_totalResults",
        "data_type": "int",
        "group_name": "Activity"
    },
    "type": {
        "name": "type",
        "display_name": "Type",
        "analyzed": false,
        "group_name": "Activity",
        "typeahead": false
    },
    "Name": {
        "analyzedname": false"name",
        "groupdisplay_name": "UserName",
    },     "analyzed": false,
        "Emailgroup_name": "User"
{    },
    "analyzedEmail": false,{
        "group_name": "Useremail",
    },     "Roledisplay_name": {"Email",
        "analyzed": false,
        "group_name": "User"
    },
    "GroupsRole": {
        "name": "role",
        "display_name": "User GroupRole",
        "analyzed": false,
        "group_name": "User"
    },
    "commentGroups": {
        "name": "Commentgroups",
        "groupdisplay_name": "ActivityGroups"
,
   },     "ratinganalyzed": {false,
        "group_name": "Rating"User"
    },
    "user_email": {
        "group_name": "Activityuser_email",
    },     "userdisplay_emailname": {"User Email",
        "import": false
    }
}

For manually created monitoring projects, the Squirro Activity Log data loader plugin uses a custom index with name squirro_v9_${project_id}. The index is required to set up the popular queries suggestions.

Activity Dataloader Plugin

The data loader plugin reads by default the path with activity files from the common.ini config.
If you would like to provide a custom path where your activity files are stored, you can specify the Activity path option in the advanced options.

...

Running data loader on multi-node instances and storing files in the EFS

The Squirro Activity Log data loader plugin works both on multi-node instances and with activity files placed in the EFS. It takes care of loading proper data by resolving the hostname folder where the activity files are stored.

The plugin gathers the activity files from the root level of the activity path and then check for files inside the folder with corresponding hostname. If it finds a folder with the same hostname as the hostname that it is running on, it also searches for files inside this folder.

So assuming the data loader runs on the instance with the hostname: hostname-1, it will gather the following files:

  • /var/log/squirro/frontend/activity.2022-01-01.jsonl

  • /var/log/squirro/frontend/hostname-1/activity.2022-01-02.jsonl

But won't gather the file below:

  • /var/log/squirro/frontend/hostname-2/activity.2022-01-03.jsonl