Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fileset indexing: address performance issues and add configurability #156

Merged
merged 11 commits into from
Mar 9, 2023
Merged

Fileset indexing: address performance issues and add configurability #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
84703a0
Add omero.search.max_fileset_size property
sbesson Feb 8, 2023
6fe5251
Improve comment about cut-off rationale
sbesson Feb 8, 2023
d1112ae
Update legacy references to Trac
sbesson Feb 8, 2023
ff34496
Add performance warning to properties description
sbesson Feb 8, 2023
1c01cd0
Only add templatePrefix once
sbesson Feb 9, 2023
66f22be
Increase default max fileset size to 10
sbesson Feb 9, 2023
8a5707b
Fix hyperlink markup
sbesson Feb 22, 2023
5579ad7
Update src/main/java/ome/services/fulltext/FullTextBridge.java
sbesson Feb 24, 2023
6d8d975
Convert maxFilesetSize into a property
sbesson Mar 7, 2023
db7a913
Rework the fileset indexing logic to index up to the cut-off
sbesson Mar 7, 2023
23a8902
Skip the fileset indexing if maxFilesetSize is 0 (or lower)
sbesson Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions src/main/java/ome/services/fulltext/FullTextBridge.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,8 @@
*
* @author Josh Moore, josh at glencoesoftware.com
* @since 3.0-Beta3
* @see <a href="https://trac.openmicroscopy.org.uk/ome/FileParsers">Parsers</a
* href>
* @see <a href="https://trac.openmicroscopy.org.uk/ome/SearchBridges">Bridges</a
* href>
* @see <a href="https://omero.readthedocs.io/en/stable/developers/Search/FileParsers.html">Parsers</a>
* @see <a href="https://omero.readthedocs.io/en/stable/developers/Modules/Search/Bridges.html">Bridges</a>
*/
@Deprecated
public class FullTextBridge extends BridgeHelper {
Expand All @@ -67,6 +65,7 @@ public class FullTextBridge extends BridgeHelper {
final protected OriginalFilesService files;
final protected Map<String, FileParser> parsers;
final protected Class<FieldBridge>[] classes;
protected int maxFilesetSize;

/**
* Since this constructor provides the instance with no way of parsing
Expand Down Expand Up @@ -100,8 +99,7 @@ public FullTextBridge(OriginalFilesService files,
* set of {@link FieldBridge bridge classes} which will be
* instantiated via a no-arg constructor.
* @see <a
* href="https://trac.openmicroscopy.org.uk/ome/SearchBridges">Bridges</a
* href>
* href="https://omero.readthedocs.io/en/stable/developers/Modules/Search/Bridges.html">Bridges</a>
*/
@SuppressWarnings("unchecked")
public FullTextBridge(OriginalFilesService files,
Expand All @@ -111,6 +109,15 @@ public FullTextBridge(OriginalFilesService files,
this.classes = bridgeClasses == null ? new Class[] {} : bridgeClasses;
}

/**
* Sets the cut-off for indexing filesets
* @param maxFilesetSize the maximume fileset size
*/
public void setMaxFilesetSize(int maxFilesetSize) {
logger().info("Setting maximum fileset size to {}", maxFilesetSize);
this.maxFilesetSize = maxFilesetSize;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default in the constructor above is set to 1.
This could allow to pass any value including negative one. Maybe add a check

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you and/or anyone else who was involved in the initial review of the feature foresee a situation where someone would like to preserve the current behavior i.e. index all files in a fileset irrespectively of its size?

If so, -1 (or any negative value?) could be used as a mechanism to skip the fileset size check, with all associated warnings re performance implications. Otherwise, I can make this default to 1 if it's negative.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't involved in the initial review or discussion around the feature back in late 2019. However, purely from a technical perspective I can see justification for leaving this open ended. If we add range checks here in the constructor they will apply to all subclasses and that seems like a bad design decision. There are other ways of doing this with Spring such as using properties rather than constructor arguments but I don't know if that's needed here.

}

/**
* Default implementation of the
* {@link #set(String, Object, Document, LuceneOptions)}
Expand Down Expand Up @@ -388,24 +395,39 @@ public void set_folders(final String name, final IObject object,
*
* - fileset.entry.clientPath
* - fileset.entry.name
* - fileset.templatePrefix
*/
public void set_fileset(final String name, final IObject object,
final Document document, final LuceneOptions opts) {
if (object instanceof Image) {
final Image image = (Image) object;
final Fileset fileset = image.getFileset();
if (fileset == null) {
if (fileset == null || maxFilesetSize < 1) {
return;
}

add(document, "fileset.templatePrefix", fileset.getTemplatePrefix(), opts);

final Iterator<FilesetEntry> entryIterator = fileset.iterateUsedFiles();
int index = 0;
while (entryIterator.hasNext()) {
final FilesetEntry entry = entryIterator.next();
if (entry == null) {
continue;
}

// Skip fileset indexing above a cut-off
// As the fileset indexing scales with the number of fileset entries for each
// image, this operation can quickly lead to performance degradation notable
// in domains like high-content screening where each of 1K-10K images in a plate
// can be associated with 10-100K files
index++;
if (index > maxFilesetSize) {
return;
}

add(document, "fileset.entry.clientPath", entry.getClientPath(), opts);
add(document, "fileset.entry.name", entry.getOriginalFile().getName(), opts);
add(document, "fileset.templatePrefix", fileset.getTemplatePrefix(), opts);
}
}
}
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/ome/services/service-ome.api.Search.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<constructor-arg ref="fileParsers"/>
<constructor-arg ref="/OMERO/Files"/>
<constructor-arg value="${omero.search.bridges}"/>
<property name="maxFilesetSize" value="${omero.search.max_fileset_size}"/>
</bean>

<!-- Use "*" as a wildcard parser -->
Expand Down
6 changes: 6 additions & 0 deletions src/main/resources/omero-server.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@ ome.model.screen.PlateAcquisition,ome.model.screen.Well
# modified.
omero.search.include_actions=INSERT,UPDATE,REINDEX,DELETE

# Maximum number of fileset entries which will be indexed
# Increasing this cut-off can lead to indexing performance degradation
# notably in the high-content screening domain where plates typically
# contain 1K-10K images associated with 10-100K fileset entries each
# If set to 0, no fileset entry will be indexed
omero.search.max_fileset_size=10

##
## Old loader: "persistentEventLogLoader"
Expand Down