coldtrick/opensearch

An OpenSearch implementation for Elgg

v7.0.1 2024-10-10 12:29 UTC

Requires

• opensearch-project/opensearch-php: ^2.0.0

Conflicts

• elgg/elgg: <6.0

GPL-2.0-only

• plugin
• search
• lucene
• opensearch
• elgg

README

An OpenSearch implementation for Elgg

Requirements

A working OpenSearch server is required. Also the minute cron has to be working on your Elgg installation. The minute cron is used to update the index with all the required changes (create/update/delete).

The current supported version of OpenSearch is: 2.5.x

Configuration

Settings

The plugin settings allow you to configure the following:

• Hosts: 1 or more hosts need to be configured (full URL + optional port number). You can provide more hosts comma seperated.
• Index: Name of the index used for indexing Elgg data and search queries
• Search alias (optional): Name of the alias to use in search queries, this allows for easy searching across multiple indices

Index Management

The index management page (found under Administer -> OpenSearch -> Indices in the admin sidebar) allows you to perform various actions on all the indexes available on the OpenSearch server. The following actions are supported:

• Create: This action can only be performed if the index configured in the plugin settings page is not yet available. It will create the default index configuration to be used for search.
• Alias: Add/remove the configured alias to the index (this allows searching across multiple indices)
• Delete: This will remove the index from the server (this action can not be undone)

Administration

Log files

Based on the log level of your Elgg site, there will also be logging of the OpenSearch PHP client library. Logging will appear in the same location as all other Elgg logs.

Statistics

You can find various statistics on the Administer -> OpenSearch -> Statistics page. Elgg statistics report on the amount of entities found in the Elgg database that should be in the index. It also reports on the amount of entities that need to be added/updated/deleted in the index and that are currently waiting on the minute cron to process them.

Also some statistics from the OpenSearch Cluster are shown like the status and the version information.

You can also find statistics for all available indexes on this page.

CLI commands

CLI commands are available to be used with the default elgg-cli command

opensearch:rebuild

This command will rebuild the current OpenSearch index with new configuration and/or mappings. This only works when there is an active index. Only use this command when a change was made to the index configuration and/or mappings.

opensearch:sync

This command will synchronize all pending entities to the OpenSearch index. This is especially usefull during the reindexing process of the database because a lot of entities need to be indexed. Using the normal cron task in this case could take a long time.

Recommendations

Use the Search Advanced plugin to add extra features to search. If both are enabled this plugin provides a menu to sort/order the results.

Developers

Plugin events

'boostable_types', 'opensearch'

Return an array of type.subtype to be used for configuring boosting in OpenSearch.

In the format:

[
	'type.subtype',
]

Defaults to the registered searchable type/subtypes for OpenSearch.

'config:index', 'opensearch'

Return an array with the index configuration to be used by OpenSearch.

'config:mapping', 'opensearch'

Return an array with the mapping configuration to be used by OpenSearch.

'export:counters', 'opensearch'

Return an array of counters to be exported to OpenSearch.

In the format:

[
	'counter_name' => counter_value
]

Params contain:

• entity: the ElggEntity being exported

'export:metadata_names', 'opensearch'

Return an array of metadata names to be exported to OpenSearch.

Params contain:

• entity: the ElggEntity being exported

'export:relationship_names', 'opensearch'

Return an array of relationship names to be exported to OpenSearch.

Params contain:

• entity: the ElggEntity being exported

'index_entity_type_subtypes', 'opensearch'

Return an array of type/subtypes allowed to be indexed by OpenSearch.

In the format:

[
	'type' => ['subtype1', 'subtype2'],
]

Defaults to all registered searchable type/subtypes in Elgg.

'index:entity:prevent', 'opensearch'

Return true if the provided entity shouldn't be added to the OpenSearch index

Params contain:

• entity: the ElggEntity about to be indexed

Default: false

'index:entity:type', 'opensearch'

Return a string under which type/subtype the entity should be indexed. This is used for type filtering during the search (eg. all blogs)

Params contain:

• entity: the ElggEntity about to be indexed
• default: the default type/subtype for this entity

Default: {entity_type}.{entity_subtype} (eg. object.blog)

'params', 'opensearch'

Return an array of parameters to be using in initializing the \ColdTrick\OpenSearch\Client OpenSearch client.

'search', 'type_subtype_pairs'

Return an array of type/subtypes allowed to be searched by OpenSearch.

In the format:

[
	'type' => ['subtype1', 'subtype2'],
]

Defaults to all registered searchable type/subtypes in Elgg.

'search_params', 'opensearch'

Return an \ColdTrick\OpenSearch\Di\SearchService to be used for the search. This allows you to alter the search parameters in opensearch.

Params contain:

• search_params: an array of the search parameters as provided by Elgg search

'to:entity:before', 'opensearch'

Change the OpenSearch hit data before it's converted to an ElggEntity

Params contain:

• hit: the result from OpenSearch
• search_params: an array of the search parameters as provided by Elgg search

'to:entity', 'opensearch'

Return an ElggEntity based on the search result data from OpenSearch.

Params contain:

• hit: the result from OpenSearch
• search_params: an array of the search parameters as provided by Elgg search

Parameters passed to elgg_search

field_boosting

In the parameters passed to elgg_search you can add a configuration to control field boosting in OpenSearch. Add the key field_boosting to the array which holds an array with field-name and the boosting for that field.

Example:

[
	'field_boosting' => [
		'title' => 2, // title is worth double
		'description' => 0.5 // description is worth half
	],
]