3.8.5 - Release Notes#

Squirro 3.8.5 was released September 29, 2023.

Reference: Learn more about the Squirro Release Process.

What’s New#

  • Storybook was updated to the latest version, add full widgets to storybook and community list widget tests

  • Search Scoring Profiles: Implemented with_user_read profile to tag read items before returning them via the query API.

  • The plumber service can now emit structured logs. Structured logs generated during data ingestion (e.g. from the execution of a pipelet in a pipeline workflow) can now be included in the Data Ingestion Logs dashboard of the Squirro Monitoring project. Authors of pipelets can use the new attribute self.slog to emit structured logs from within their pipelets.

  • Added a Similar Items tab to the Items Detail widget.

  • Added the indexmanager service.


  • Ensured all connections have a 20-second timeout, including the /_internal/status endpoint.

  • Within search, for better statistics on the indexed data, page offsets are now stored on PDF sub-items as numbers.

  • Enabled placeholders in dataloader inputs.

  • Added support to leverage multiple search scoring profiles at the execution stage (rerank, render).

  • Squirro now applies ACL queries as Elasticsearch filters. It allows Elasticsearch to cache the filters, thus users with the same ACLs will get results faster.

  • Now, squirro_status works even if a service is not installed.

  • Show more than X number of results in Items widget when approximation is used on the backend.

  • Suppressed the Instantiate SkipTimeoutConnectionClass message in squirro_status output.

  • Reduced noisy logging in frontend.log by the monitoring plugin.

  • Added Label selection during deploy of a model within AI Studio.

  • Added support for the NOT literal for search scoring profiles.

  • Exposed search tuning parameters to the project configuration. This allows users to config additional Elasticsearch query API performance parameters.

  • Improvements to the Data Ingestion Logs dashboard in the Squirro Monitoring project. Specifically, batch-level start/end logs have been added for the pipeline steps operating in parallel execution mode. All batch-level start/end logs are now logged at the info logging level, while all item-level start/end logs (which provide more detail, supported for steps with parallel execution mode) are logged at the debug logging level. Therefore, from now on, start/end logs will be displayed by default in the dashboard without the need to modify the logging level to debug. Finally, structured logs have been added in a few places to assist with understanding.

  • Store read item IDs on the frontend to show the correct status immediately to the user.

  • Changed the default font size for the Chip component to 13px.

  • Disabled visibility of the Explore tab in the Dashboards space.

  • Now, Orjson is used in the WebOb package to improve the speed of parsing responses.

Bug Fixes#

  • If Squirro is deployed with a single Redis instance for both cache and persistent storage, then the cached studio plugin could lead to accidental data loss because it uses the flushall() call for the entire instance. This is now detected and prevented.

  • Fixed an issue with Data Sources/Explore sources.

  • Fixes to the Notes widget.

  • Fixed an issue with favorites editing in the Salesforce Iframe component.

  • Fixed an issue with PDF item load not triggered when adjusting search filters.

  • Within Global Search, the typeahead API now feeds global search with correctly joined tokens (as used for chip rendering).

  • Fixed an issue where the query breaks when searching with Searchbar Widget on the Explore dashboard in the Setup space.

  • Fixed an issue where the Clear button persisted when it shouldn’t in the filter widget.

  • Disabled query_results_cache_enabled per default. We rely now only on Elasticsearch to cache aggregations results and filter query clauses. The query cache was used to cache the expected response of a query string. With the introduction of dynamically injected query clauses coming from scoring plugins (e.g. based on user behavior), the very same query string will not return the same items anymore but boosts/recommends documents based on behavioral signals.

  • Added missing python-magic dependency.

  • Fixed item detail highlights not ordering correctly.

  • Fixed an issue with missing query_id in CommunityItem and CommunitiesBanner activity tracking.

Breaking Changes#

  • Adding a document-level classification model to a pipeline now requires the document_label argument that defines the label category used for the model to output its predictions.

  • Changed the default value of track_total_hits from true to 500,000 to optimize query performance. This means that Elasticsearch will now stop counting documents when the value exceeds this threshold. To change this behavior, see the track_total_hits option in the topic.search.search-settings configuration service option.

Installation and Upgrade#

For new installations, find step-by-step instructions in Install and Manage Squirro with Ansible (recommended) or Installing Squirro on Linux.

To upgrade an existing installation, see Upgrading Squirro.