From 692b8ee4847444441709cb70a498976f3ea93880 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Besson?= Date: Wed, 19 Jun 2024 09:23:01 +0100 Subject: [PATCH 1/3] Add documentation for the omero.logging properties All these properties are defined in OMERO.py so changing the default value in this file has no effect but allows for the configuration to be included in the reference documentation --- etc/omero.properties | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/etc/omero.properties b/etc/omero.properties index fbca6d38c94..d75ac6cead5 100644 --- a/etc/omero.properties +++ b/etc/omero.properties @@ -51,8 +51,8 @@ omero.ports.registry=4061 ## JVM configuration ## ## Note: changes to the omero.jvmcfg properties -## will *not* be reflected in the compiled server -## since they are defined in a Python file. +## will *not* be reflected in OMERO.server +## since they are defined in OMERO.py. ############################################# ## (For documentation only) # Memory strategy which will be used by default. @@ -115,6 +115,43 @@ omero.jvmcfg.min_system_memory=3414 omero.jvmcfg.max_system_memory=48000 +############################################# +## Logging properties +## +## Note: changes to the default omero.logging values in +## this file will *not* be reflected in OMERO.server +## since they are defined in OMERO.py +############################################# + +## (For documentation only) +# Relative server directory where the log files should be stored. +omero.logging.directory=var/log/ + +## (For documentation only) +# Whether the server log files should be rotated at a certain time +# interval. If true, log files will be rolled over at midnight. +# Otherwise, log files will be rolled over at a predetermined size, +# see omero.logging.logsize for more information. +omero.logging.timedlog=False + +## (For documentation only) +# If omero.logging.timedlog is False or unset, specifies the +# maximum size of the server log files in bytes above which a +# new log file should be created. +omero.logging.logsize=5000000 + +## (For documentation only) +# If omero.logging.timedlog is False or unset, specifies the +# number of old server log files that should be kept. Old log +# files will be saved by appending the extensions '.1', '.2' etc. +omero.logging.lognum=9 + +## (For documentation only) +# Specifies the threshold for the server log files. Logging messages +# which are less severe than this value will be ignored. For a list of +# available values, see https://docs.python.org/3/library/logging.html#levels. +omero.logging.level=20 + ############################################# ## Ice overrides ## From b73a17c5f0e8f7b3f8f6d3b036152ce73fd0638f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Besson?= Date: Fri, 21 Jun 2024 11:09:41 +0100 Subject: [PATCH 2/3] Use lowercase false for omero.logging.timedlog --- etc/omero.properties | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/etc/omero.properties b/etc/omero.properties index d75ac6cead5..dd1a4a17d4d 100644 --- a/etc/omero.properties +++ b/etc/omero.properties @@ -132,16 +132,16 @@ omero.logging.directory=var/log/ # interval. If true, log files will be rolled over at midnight. # Otherwise, log files will be rolled over at a predetermined size, # see omero.logging.logsize for more information. -omero.logging.timedlog=False +omero.logging.timedlog=false ## (For documentation only) -# If omero.logging.timedlog is False or unset, specifies the +# If omero.logging.timedlog is false or unset, specifies the # maximum size of the server log files in bytes above which a # new log file should be created. omero.logging.logsize=5000000 ## (For documentation only) -# If omero.logging.timedlog is False or unset, specifies the +# If omero.logging.timedlog is false or unset, specifies the # number of old server log files that should be kept. Old log # files will be saved by appending the extensions '.1', '.2' etc. omero.logging.lognum=9 From dc85eef0e70adab8456617cf71f2b08f88a265ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Besson?= Date: Wed, 26 Jun 2024 12:25:42 +0100 Subject: [PATCH 3/3] Clarify that omero.logging.level is only for Python servers --- etc/omero.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/etc/omero.properties b/etc/omero.properties index dd1a4a17d4d..4d3cf18ba6b 100644 --- a/etc/omero.properties +++ b/etc/omero.properties @@ -147,7 +147,7 @@ omero.logging.logsize=5000000 omero.logging.lognum=9 ## (For documentation only) -# Specifies the threshold for the server log files. Logging messages +# Specifies the threshold for the Python servers log files. Logging messages # which are less severe than this value will be ignored. For a list of # available values, see https://docs.python.org/3/library/logging.html#levels. omero.logging.level=20