search

ome / openmicroscopy

OME (Open Microscopy Environment) develops open-source software and data format standards for the storage and manipulation of biological light microscopy data. A joint project between universities, research establishments and industry in Europe and the USA, OME has over 20 active researchers with strong links to the microscopy community. Funded by private and public research grants, OME has been a major force on the international microscopy stage since 2000.
https://www.openmicroscopy.org/omero
GNU General Public License v2.0
200 stars 102 forks source link

Add documentation for the omero.logging properties #6393

Closed sbesson closed 4 months ago

sbesson commented 4 months ago

Initial step towards fixing #6225

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

will-moore commented 4 months ago

Looks good. Text makes sense.

So this PR is purely to update the docs at https://omero.readthedocs.io/en/latest/sysadmins/config.html? Trivial point: I noticed there that all booleans tend to be lowercase false whereas you have a mix (although I think it doesn't matter since they are all lowercased when comparing, but just for consistency).

sbesson commented 4 months ago

So this PR is purely to update the docs at https://omero.readthedocs.io/en/latest/sysadmins/config.html?

Absolutely, the default logging values are defined in https://github.com/ome/omero-py/blob/8d8108de02104c654741d65f0ecbbf11c85e329d/src/omero/util/__init__.py#L32-L38 so modifying etc/omero.properties has no functional effect.

But it is currently undocumented that the server logs can be configured using the standard omero config approach and this PR aims to update the documentation to include these properties.

Trivial point: I noticed there that all booleans tend to be lowercase false whereas you have a mix (although I think it doesn't matter since they are all lowercased when comparing, but just for consistency).

Pushed b73a17c5f0e8f7b3f8f6d3b036152ce73fd0638f to use the current lowercase convention consistently

sbesson commented 4 months ago

While using these properties as part of the review of https://github.com/ome/omero-py/pull/417, one important aspect worth noting is that the omero.logging.level property only affects the Python servers (like Processor or Tables). This is consistent with what is described in https://omero.readthedocs.io/en/stable/developers/logging.html.

The last commit should update the property description to be explicit about this.