Parámetros de configuración de rendimiento

Cola de extracción de texto

Existen varios parámetros de configuración para adaptar la extracción de texto de los documentos a sus necesidades. La extracción de texto es uno de los procesos que pueden consumir muchos recursos de hardware (memoria y CPU). Una política de extracción de texto agresiva puede reducir el rendimiento de la aplicación y afectar a la sensación del usuario final con la interfaz de usuario.

Cuando se suben documentos, se añaden automáticamente a la Text extraction queue. Puede ver la cola de extracción de texto en Administration > Statistics > Text extraction queue.

Existe una tarea crontab llamada “Text extractor worker” en Administration > Cron tab que controla el ciclo de indexación

Precaución

Cuando se sube un documento, no será posible buscarlo por contenido hasta que sea procesado por la cola de extracción de texto.

Precaución

En caso de que la aplicación necesite indexar muchos archivos al día, o de que haya importado una cantidad considerable de archivos, considere crear dos tareas crontab para cambiar estos parámetros entre el día (menos agresivo) y la noche (más agresivo).

Precaución

Algunos tipos MIME, como pdf o las imágenes (que necesitan un motor de OCR), pueden consumir mucha CPU (hasta el 100%).

Campo / Propiedad	Tipo	Descripción
text.extraction.batch	Boolean	Indica el número de documentos que se procesarán en cada ciclo de indexación. Cuando el parámetro “text.extraction.concurrent” está habilitado, es una buena práctica que sea múltiplo del valor de “text.extraction.threads”. 20
text.extraction.concurrent	Boolean	Habilita o deshabilita la funcionalidad de extracción de texto con hilos concurrentes. True
text.extraction.threads	Integer	Número de hilos concurrentes que se utilizarán para la extracción de texto. Este número debería ser menor o igual que el número de núcleos de hardware. 2

Servicio de conversión de OpenOffice y LibreOffice

Como parte del arranque de la aplicación, OpenKM ejecuta un servicio de OpenOffice o LibreOffice. Se utiliza internamente con fines de conversión, por ejemplo para convertir archivos doc a pdf.

El servicio de OpenOffice o LibreOffice puede consumir muchos recursos de hardware (CPU hasta el 100%), lo que puede reducir el rendimiento de la aplicación. Una buena práctica es trasladar el servicio de conversión de OpenOffice o LibreOffice a otro servidor.

Campo / Propiedad	Tipo	Descripción
system.openoffice.server	String	URL del servicio de OpenOffice o LibreOffice. http://192.168.1.34:8080/converter/convert
system.openoffice.tasks	String	Reinicia el servicio tras x conversiones para evitar fugas de memoria. 5

Para más información, lea:

• Parámetros de configuración de OpenOffice y LibreOffice
• Configuración de LibreOffice

Descargar archivos y carpetas como archivo ZIP

No es una buena práctica descargar como ZIP un gran volumen de archivos. En la mayoría de los casos, considere la herramienta de exportación de la aplicación en Administration > Utilities > Repository export.

Descargar archivos y carpetas como archivo ZIP puede requerir mucho tiempo y recursos de hardware. Primero, la aplicación preparará una carpeta temporal en el servidor que se utilizará para crear el archivo ZIP y, finalmente, se enviará a la interfaz de usuario. Para evitar bloquear la interfaz de usuario esperando a que finalice el proceso, existen dos parámetros que detectarán que el usuario ha superado algunos límites (número de archivos o tamaño) y el proceso pasará a modo en segundo plano.

Campo / Propiedad	Tipo	Descripción
download.zip.live.max.files	Integer	Establece el número máximo de archivos que se pueden descargar en modo en vivo. 100
download.zip.live.max.file.size	String	Establece el tamaño máximo del conjunto de archivos que se pueden descargar en modo en vivo.

Para más información sobre estos parámetros, lea Parámetros de configuración de la interfaz de usuario.

Comprobador de antivirus

Existen varios parámetros de configuración para adaptar el comprobador de antivirus a sus necesidades. El comprobador de antivirus es uno de los procesos que pueden consumir muchos recursos de hardware (memoria y CPU). Una política de comprobación de antivirus agresiva puede reducir el rendimiento de la aplicación y afectar a la sensación del usuario final con la interfaz de usuario. El comprobador de antivirus puede funcionar en modo en vivo (durante la subida, el antivirus comprueba el documento y, si se detecta un virus, se genera inmediatamente un error de advertencia y el documento no se incorpora al repositorio) o comprobar en modo en segundo plano.

Precaución

El comprobador de antivirus en modo en vivo puede empeorar drásticamente la interfaz de usuario y la sensación del usuario final. Tenga en cuenta que, para analizar algunos documentos, el antivirus puede tardar 3 segundos o más, que se sumarán al tiempo del proceso de subida.

Precaución

En caso de que la aplicación necesite analizar muchos archivos al día, o de que haya importado una cantidad considerable de archivos, considere crear dos tareas crontab para cambiar estos parámetros entre el día (menos agresivo) y la noche (más agresivo).

Campo / Propiedad	Tipo	Descripción
system.antivir	String	Establece la ruta del antivirus.
background.antivirus.check	Boolean	Habilita o deshabilita el comprobador de antivirus en segundo plano. Por defecto está establecido en false. Existe una tarea crontab (Administration > Crontab) llamada Antivirus Checker Worker que controla el comprobador de antivirus en segundo plano. Cuando la comprobación en segundo plano está deshabilitada, el antivirus se procesa mientras se sube cualquier documento. Eso puede añadir tiempo extra al proceso de subida (en algunos casos, el antivirus necesita más de 3 segundos para comprobar un documento). Cuando realiza una importación masiva de archivos, el tiempo total para completar la operación puede multiplicarse por 3 o más con esta opción deshabilitada, porque como parte. Nuestra sugerencia es habilitarla. true
background.antivirus.check.threads	Integer	Número de hilos concurrentes que se utilizarán para el antivirus. Este número debería ser menor o igual que el número de núcleos de hardware. 2
background.antivirus.check.batch	Integer	Indica el número de documentos que se procesarán en cada ciclo de indexación. Cuando el parámetro “background.antivirus.check” está habilitado, es una buena práctica que sea múltiplo del valor de “background.antivirus.check.threads”. 20

Para más información, lea Parámetros de configuración del antivirus.

Reindexar todo el repositorio de Lucene

La aplicación puede utilizar dos formas distintas de reconstruir los índices de Lucene: secuencial o paralela. Por defecto está habilitada la reindexación secuencial, pero puede seleccionar el modo mediante el parámetro de configuración “hibernate.indexer.mass.indexer”.

Campo / Propiedad	Tipo	Descripción
hibernate.indexer.mass.indexer	Boolean	Cuando está habilitado, el proceso de reconstrucción de los índices de Lucene pasa a “Parallel mode”.

Modo	Descripción
Modo secuencial	Puede utilizar el parámetro de configuración “hibernate.indexer.batch.size.load.objects” para indicar a Hibernate cuántos objetos debe manejar cada vez. Para evitar problemas de OutOfMemory, el repositorio debe reindexarse por lotes. Si el valor de esta propiedad es demasiado bajo, el rendimiento será malo, pero si es demasiado alto puede tener problemas de OutOfMemory. - hibernate.indexer.batch.size.load.objects: tamaño de lote utilizado para cargar las entidades raíz. 30
Modo paralelo	Dispone de varias propiedades de configuración para ajustar su rendimiento: - hibernate.indexer.batch.size.load.objects: tamaño de lote utilizado para cargar las entidades raíz. 30 - hibernate.indexer.threads.subsequent.fetching: número de hilos utilizados para cargar las colecciones perezosas relacionadas con las entidades indexadas. 8 - hibernate.indexer.threads.load.objects: número de hilos utilizados para cargar las entidades raíz. 4 - hibernate.indexer.threads.index.writer: número de hilos utilizados para analizar los documentos y escribir en el índice. 3

Tiempo máximo de ejecución

La aplicación ejecuta aplicaciones externas para procesar documentos; por ejemplo, extrae el texto con un motor de OCR, analiza con un software antivirus o transforma documentos a otros formatos, entre otras acciones. A veces estos procesos pueden tardar mucho tiempo o, por algún motivo, no finalizar correctamente, y el proceso sigue consumiendo recursos en el sistema operativo. Para evitarlo, el parámetro “system.execution.timeout” establece el tiempo máximo de ejecución permitido para las aplicaciones externas.

Campo / Propiedad	Tipo	Descripción
system.execution.timeout	Integer	Establece el tiempo máximo de ejecución permitido para las aplicaciones externas. La unidad son minutos. Por defecto, la configuración es de 5 minutos. 5

Ancho de banda de subida

A veces desea restringir el ancho de banda total utilizado por cada usuario al subir archivos.

Campo / Propiedad	Tipo	Descripción
upload.throttle.filter	Boolean	Limita el ancho de banda total de subida a 10kb/seg por usuario.

Servicio de conversión remoto

En repositorios enormes con muchos usuarios concurrentes es buena idea configurar un servidor solo para la transformación de documentos.

Nota

Para habilitar esta funcionalidad es necesario instalar una aplicación de servicio específica de OpenKM. Póngase en contacto con el personal técnico de OpenKM para más información.

Campo / Propiedad	Tipo	Descripción
remote.conversion.server	String	Establece la URL del servicio de conversión. http://192.168.2.1:8080/converter/convert

Acciones del registro de actividad

OpenKM puede registrar mucha información relacionada con la actividad de los usuarios, pero a veces no es necesario registrar estas acciones, que llenan su tabla del registro de actividad.

Precaución

La tabla donde se almacena el registro de actividad - OKM_ACTIVITY - puede crecer rápidamente y almacenar millones de registros.

Existe una propiedad de configuración llamada “activity.log.actions” donde puede establecer qué acciones se registran. Por defecto se establecen las acciones más habituales o interesantes. Puede utilizar expresiones regulares para definir estas acciones. Lea Java Regex Tutorial para más información sobre las expresiones regulares de Java.

Campo / Propiedad	Tipo	Descripción
activity.log.actions	List	LOGIN LOGOUT CREATE_.* DELETE_.* PURGE_.* MOVE_.* COPY_.* CHECKOUT_DOCUMENT CHECKIN_DOCUMENT GET_DOCUMENT_CONTENT.* MISC_TEXT_EXTRACTION_FAILURE

Nota

Para una lista completa de acciones, consulte Registro de actividad.

Actividad del panel

El panel de OpenKM muestra una vista global de la actividad de la aplicación. Para ello, la aplicación necesita procesar una enorme cantidad de información, lo que puede reducir el rendimiento global de la aplicación (por ejemplo, para obtener los últimos documentos subidos al sistema, OpenKM puede ejecutar consultas lentas en la base de datos). Por ello, en repositorios enormes sugerimos deshabilitar la actividad del panel.

Campo / Propiedad	Tipo	Descripción
dashboard.user.activity	boolean	Establézcalo en false para deshabilitar la funcionalidad.

Lucene

El motor de búsqueda Lucene puede deshabilitarse o configurarse de varias formas. Según ello, el comportamiento de la aplicación y el rendimiento general pueden cambiar.

Nota

Estos parámetros de configuración van en el archivo de configuración “OpenKM.cfg”.

Campo / Propiedad	Tipo	Descripción
hibernate.search	String	Habilita o deshabilita el motor de búsqueda Lucene. Valores permitidos: - on - off on
hibernate.search.worker.execution	String	Establece el modo de ejecución del worker de Lucene. Por defecto es “sync”, lo que significa que cada modificación de una entidad no finaliza hasta que el índice de Lucene se ha actualizado correctamente. En el caso de “async”, estas modificaciones de entidades serán más rápidas porque la parte de Lucene se añade a una cola y se procesa en un hilo en segundo plano. Valores permitidos: - sync - async sync
hibernate.search.worker.buffer.queue.max	Integer	El tamaño de la cola del worker para almacenar las tareas pendientes de modificación del índice cuando todos los hilos del worker están ocupados. Cada acción de actualización del índice se encolará para minimizar el tiempo de modificación de la entidad. Además, un hilo consumirá esta cola ejecutando las acciones de modificación del índice. Este parámetro solo tiene sentido en el caso de ejecución asíncrona.  256
hibernate.search.worker.thread.pool.size	Integer	Establece el tamaño del pool de workers. Es el número de hilos que gestionan las tareas de modificación del índice. Los valores permitidos son enteros a partir de 1. Más de 2 no será mejor, porque solo un hilo puede modificar el índice al mismo tiempo. Este parámetro solo tiene sentido en el caso de ejecución asíncrona. 1