Mercurial > hg > orthanc-book

annotate Sphinx/source/faq/log.rst @ 998:bd7fbe3042f7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
recycling/protection
author Alain Mazy <am@osimis.io>
date Mon, 18 Dec 2023 09:47:49 +0100
parents d43d74afdfad
children 17bf6fafb884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _log:
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
126
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 124
diff changeset
3 Collecting logs
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 124
diff changeset
4 ---------------
124
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
5
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
6 Standard logs
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
7 =============
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
8
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
9 Everytime the Orthanc service starts, it will generate
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
10 a new log file in ``C:\Program Files\Orthanc Server\Logs`` on Windows
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
11 and in ``/var/log/orthanc/`` on Linux.
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
12
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
13 By default, on Windows, if the Orthanc service fails to start, it will
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
14 retry to start 5 times and stop so it does not generate thousands of log files.
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15
124
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
16 Log files are named as ``Orthanc.log.YYYYMMDD-hhmmss.ffff`` including
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
17 the date/time when Orthanc was started.
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
18
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
19 Orthanc is not removing old logs so these log files might accumulate
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
20 and consume lot's of space. It's up to you to manage the logs folder
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
21 to make sure you don't fill your disk with logs.
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
22
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
23
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
24
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
25 Generating an exploitable debug log
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
26 ===================================
cd0be128127d added info about standard logs
amazy
parents: 122
diff changeset
27
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
28 .. highlight:: bash
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
29
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
30 By default, the Orthanc logs contain only the ``WARNING`` and
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
31 ``ERROR`` information levels. For your logs to be exploitable by the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
32 Orthanc community, you must include more information by adding the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
33 ``--verbose`` or ``--trace`` command-line options, which will add the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
34 ``INFO`` and ``TRACE`` information levels. If you are starting Orthanc
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
35 from the command-line, simply add these flags and redirect the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
36 standard outputs to some log file. For instance::
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
38 $ ./Orthanc --trace --logfile=orthanc.log
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
39
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
40 Note that the Orthanc command-line tool has many other options related
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
41 to logging. Check out the :ref:`full manpage <manpage>`.
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
42
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
43 However, if you use packaged versions of Orthanc that starts the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
44 server in background (such as GNU/Linux packages or the Windows
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
45 installers by Osimis), you will have to manually start Orthanc. The
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
46 sections below explain how to achieve this goal with the officially
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
47 supported packages.
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
886
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
50 With Orthanc Explorer 2 installed
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
51 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
52
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
53 If you have the :ref:`Orthanc Explorer 2 plugin <orthanc-explorer-2>`
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
54 enabled, open the settings pane at `http://localhost:8042/ui/app/#/settings
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
55 <http://localhost:8042/ui/app/#/settings>`__ and change the verbose level
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
56 from there without restarting Orthanc:
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
57
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
58
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
59 .. image:: ../images/OE2-settings-logs.png
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
60 :align: center
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
61 :width: 800px
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
62
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
63
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
64
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 Under Windows
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 ^^^^^^^^^^^^^
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
886
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
68
bca261dac7bb logs with OE2
Alain Mazy <am@osimis.io>
parents: 810
diff changeset
69 if you used the official installer by Osimis:
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
809
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
71 1. Stop the Orthanc service. The actual process depends on your
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 version of Windows.
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
809
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
74 2. Make sure you have a ``C:\Temp`` folder available to store the log file.
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
809
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
76 3. In a command-line shell, manually start Orthanc to generate the
233
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 220
diff changeset
77 ``Orthanc.log`` file::
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78
809
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
79 $ "C:\Program Files\Orthanc Server\Orthanc.exe" --verbose "C:\Program Files\Orthanc Server\Configuration" > C:\Temp\Orthanc.log 2<&1
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
809
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
81 This will start Orthanc with exactly the same configuration as your service,
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
82 but in verbose mode.
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
83
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
84 4. Once the log has been generated (in ``C:\Temp\Orthanc.log``), stop Orthanc
23f21a00b03b updated collect log procedure for windows
Alain Mazy <am@osimis.io>
parents: 638
diff changeset
85 and possibly restart the Orthanc service.
23
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 Under Debian GNU/Linux
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 ^^^^^^^^^^^^^^^^^^^^^^
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 1. Stop the Orthanc service::
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 $ sudo /etc/init.d/orthanc stop
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 2. Manually start Orthanc (using the same configuration as the
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 service) and generate the log::
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 $ sudo -u orthanc /usr/sbin/Orthanc --verbose /etc/orthanc/ > Orthanc.log 2>&1
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 3. Restart the Orthanc service::
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 $ sudo /etc/init.d/orthanc start
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 Under Docker
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 ^^^^^^^^^^^^
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 The command-line to be used is::
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109
f99aa6a6f0c9 Generating an Exploitable Log
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 $ sudo docker run -a stderr -p 4242:4242 -p 8042:8042 --rm jodogne/orthanc --verbose /etc/orthanc > Orthanc.log 2>&1
367
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
111
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
112
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
113 Changing the log level while Orthanc is running
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
114 ===============================================
367
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
115
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
116 Starting with Orthanc 1.6.0, you can dynamically change the log level
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
117 while Orthanc is running using the :ref:`REST API <rest>`::
367
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
118
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
119 $ curl -X PUT http://localhost:8042/tools/log-level -d "verbose"
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
120 $ curl -X PUT http://localhost:8042/tools/log-level -d "trace"
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
121 $ curl -X PUT http://localhost:8042/tools/log-level -d "default"
ecdd754e16ba Rest API to change log-level
Alain Mazy <alain@mazy.be>
parents: 336
diff changeset
122
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
123
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
124 Log categories
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
125 ==============
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
126
568
090cc988c35e Orthanc 1.8.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 554
diff changeset
127 Starting with Orthanc 1.8.2, log messages are associated with a
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
128 **category**. The category indicates the subsystem of Orthanc from
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
129 which the message comes (such as the embedded HTTP server, the DICOM
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
130 communications, Lua scripts...).
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
131
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
132 It is possible to choose a different log level for each category. This
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
133 can be done when starting Orthanc as follows::
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
134
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
135 $ ./Orthanc --verbose-http --trace-dicom
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
136
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
137 This command would start Orthanc in verbose mode for HTTP-related
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
138 messages, and would enable debug messages related to DICOM. The full
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
139 list of the available log categories (``http``, ``dicom``, ``lua``,
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
140 ``plugins``...) can be found in the :ref:`manpage of Orthanc
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
141 <manpage>` or by starting Orthanc with the ``--help`` flag.
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
142
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
143 It is also possible to dynamically change the log level of a category
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
144 while Orthanc is running by using the :ref:`REST API <rest>`, for
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
145 instance::
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
146
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
147 $ curl -X PUT http://localhost:8042/tools/log-level-http -d "verbose"
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
148 $ curl -X PUT http://localhost:8042/tools/log-level-dicom -d "trace"
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
149 $ curl -X PUT http://localhost:8042/tools/log-level-plugins -d "default"
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
150
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
151 The list of the available log categories is also available through the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
152 REST API, by inspecting the URIs that are prefixed by
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
153 ``/tools/log-level``::
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
154
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
155 $ curl http://localhost:8042/tools/
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
156 [...]
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
157 "log-level",
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
158 "log-level-dicom",
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
159 "log-level-generic",
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
160 "log-level-http",
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
161 "log-level-jobs",
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
162 [...]
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
163
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
164 **Remarks:**
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
165
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
166 * Messages that are not associated with a well-identified category are
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
167 considered as belonging to the ``generic`` category.
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
168
996
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
169 * Using the ``--verbose`` or ``--trace`` command-line options, or
538
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
170 changing the value of the ``/tools/log-level`` URI will reset the
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
171 log level of **all** the categories. Note that the command-line
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
172 options are applied from left to right.
d18496f166b8 documenting the log categories, and manpage of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 528
diff changeset
173
896
Alain Mazy <am@osimis.io>
parents: 886
diff changeset
174 * Provided that you have left the ``DeidentifyLogs`` configuration to
Alain Mazy <am@osimis.io>
parents: 886
diff changeset
175 its ``true`` default value, Orthanc logs will not contain any sensitive
996
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
176 patient information.
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
177
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
178 * Starting from Orthanc 1.12.2, Orthanc is logging the thread name in the
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
179 logs. If you need to revert back to the previous format, add the
d43d74afdfad logs-no-thread
Alain Mazy <am@osimis.io>
parents: 896
diff changeset
180 ``--logs-no-thread`` command line option at startup.