Source:Setting Log Level: Difference between revisions

From SEPsesam
mNo edit summary
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__FORCETOC__
<noinclude><languages /><br />
<noinclude><languages /><br />


<translate><!--T:44-->
<translate>== How to set a log level == <!--T:36--></translate>
{{Copyright SEP AG en}}


<!--T:45-->
</noinclude><translate><!--T:48-->
{{Navigation_latest|release=[[Special:MyLanguage/SEP_sesam_Release_Versions|4.4.3/4.4.3 ''Grolar'']]|link=[[Special:MyLanguage/SEP_sesam_Documentation#previous|documentation archive]]}}</translate><br /></noinclude>
You can control the reporting (verbose) level to define the amount of detail SEP sesam logs in its error reports. By default, the log level is set to 0 for backup and restore, which logs only standard and error messages. Increasing the log level can be helpful for troubleshooting specific issues or when requested by SEP sesam support.
<translate>== How to set a log level == <!--T:36--></translate> <!--T:1-->
<noinclude><div class="boilerplate metadata" id="Additional resources" style="background-color:#ecedf1; color:#8695a7; border: 1px ridge #cdd3db; margin: 0.5em; padding: 0.5em; float: right; width: 35%; "><center><b><translate>
<!--T:37-->
Additional resources</translate></b></center>
{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
| rowspan="2" style="padding:0px 10px 0px;" | <translate>
<!--T:38-->
[[File:SEP_next.png|45px|link=Special:MyLanguage/SEP_Sesam_CLI]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | <translate>
<!--T:39-->
See also: [[Special:MyLanguage/SEP_Sesam_CLI|SEP sesam CLI]]</translate>
|}


{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
<!--T:49-->
| rowspan="2" style="padding:0px 10px 0px;" |
Increasing the log level significantly raises the volume of logged data and may impact SEP sesam performance. You should only raise the log level when investigating a specific issue or when instructed by SEP sesam support. If you modified the log level in the <tt>debug.ini</tt> file, be sure to revert it to the default value after reproducing the issue and capturing the necessary logs.
<translate>
<!--T:40-->
[[File:SEP Tip.png|45px|link=Special:MyLanguage/FAQ#higher_logging_level|FAQ]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" |
<translate>
<!--T:41-->
Check [[Special:MyLanguage/FAQ#higher_logging_level|FAQ]] to find the answers to most common questions.</translate>
|}


{|style="margin: auto; margin-bottom:1em; width:100%; border:0px solid grey;"
<!--T:55-->
| rowspan="2" style="padding:0px 10px 0px;" | <translate>
The default SEP sesam directory for logs is <tt><SESAM_VAR></tt> ({{path|/var/opt/sesam/var}}). For more information, see [[Special:MyLanguage/Directory_Layout|Directory Layout]].
<!--T:42-->
[[File:SEP Troubleshooting.png|45px|link=Special:MyLanguage/Troubleshooting_Guide|Troubleshooting Guide]]</translate>
| style="padding:0px 40px 0px 10px; color: grey; font-size: 90%; text-align:left;" | <translate>
<!--T:43-->
Problems? Check the [[Special:MyLanguage/Troubleshooting_Guide|Troubleshooting Guide]].</translate>
|}
</div></noinclude>
<translate>


<!--T:2-->
<!--T:56-->
You can control the reporting (verbose) level of the backup and restore protocol by setting a desired log level on a per-task basis. The following log levels are provided:</translate>
===SEP sesam log levels===
SEP sesam uses different log levels for various modules. The following list shows the reporting levels for the backup and restore operations, which can be set individually for each backup or restore task. The log levels are presented in order of increasing verbosity, from the least to the most detailed information logged:</translate>
{| border="2" cellpadding="4" cellspacing="0" style="width:60%; margin: 1em 1em 1em 0; background: #fcfcfc; border: 1px #aaa solid; border-collapse: collapse;"
|- style="background:#FFCC01; color:#002F55"
! scope="col" | '''<translate><!--T:3--> Setting</translate>'''
! scope="col" |'''<translate><!--T:4--> Log level details</translate>''' 
|-
|style="text-align: center;"|'''0'''||  <translate><!--T:5-->
Logs only standard and error messages, with a summary of key operations and results.</translate>     
|-
|style="text-align: center;"|'''1''' || <translate><!--T:6-->
This level provides basic progress tracking and logs a line for every item when its processing begins:</translate> ''sbc-3008: Info: Processing item: [xxx]...''
|-
|style="text-align: center;"|'''2''' || <translate><!--T:7-->
This level provides feedback on successful completion of individual items and logs a line for every item when its processing completes:</translate> ''sbc-3108: Info: Item processed successfully: [xxx]''
|-
|style="text-align: center;"|'''3''' || <translate><!--T:8-->
This level provides detailed information on backup process and logs detailed information about the processing of the backup module, including interactions with the DB_API modules.</translate>   
|-
|style="text-align: center;"|'''4''' ||<translate><!--T:9-->
This level provides detailed view of the internal operations and logs extensive details on underlying module processing, including interactions with XBSA and the DB_API modules.</translate>         
|-
|style="text-align: center;"|'''5'''  || <translate><!--T:10-->
This level provides insight into the data compression and packaging processes and logs packing data trace messages, including details about data formats like mtf, cpio, and sidf.</translate>
|}


{| class="wikitable" style="width: 90%"
=={{anchor|GUI}}<translate><!--T:57--> Setting log level for a task</translate>==  
|- style="text-align:center;"
| style="width: 10%" | '''<translate><!--T:3-->
Setting</translate>'''
| style="width: 90%" | '''<translate><!--T:4-->
Log level details</translate>'''
|- style="vertical-align:middle; text-align:center;"
| scope="row"|
'''0'''<br>
'''1'''<br>
'''2'''<br>
'''3'''<br>
'''4'''<br>
'''5'''
| style="vertical-align:middle; text-align:left;"|
*<translate><!--T:5-->
print only standard and error messages together with summary</translate><br>
*<translate><!--T:6-->
display a line for every item when its processing starts:</translate> 'sbc-3008: Info: Processing item: [xxx]...'<br>
*<translate><!--T:7-->
display a line for every item when its processing finishes:</translate> 'sbc-3108: Info: Item processed successfully: [xxx]'<br>
*<translate><!--T:8-->
display backup module processing information (with DB_API modules)</translate><br>
*<translate><!--T:9-->
display underlying module processing XBSA and detailed DB_API modules</translate><br>
*<translate><!--T:10-->
display packing data (mtf, cpio, sidf) trace messages</translate>
|-
|}


<translate>
=== {{anchor|backup}}<translate><!--T:11-->
You can also change the logging level for '''SEP sesam modules''' in the {{Path|<SESAM ROOT>/var/ini/debug.ini}} of the [[Special:MyLanguage/SEP_sesam_Glossary#SEP_sesam_Server|SEP sesam Server]] installation for specific module by selecting a value between 0-6 (0=ERROR, 1=EMERGENCY, 2=WARNING, 3=NOTICE, 4=INFO, 5=DEBUG, 6=TRACE).</translate>
Setting log level for backup ===
<translate>=== Setting log level for backup === <!--T:11-->


<!--T:12-->
<!--T:12-->
You can set the desired log level for each backup task in its properties:</translate>
You can set the desired log level for each backup task in its properties:</translate>
<ol><li><translate><!--T:13-->
#<translate><!--T:13-->
In the '''Main Selection''' -> '''Tasks''' -> '''By clients''', select your client and double-click the backup task for which you want to define the log level. The task properties window is displayed.</translate></li>
In the Web UI, navigate to ''Backup Strategy'' -> ''Backup Tasks'', then click on the backup task for which you want to define the log level. The task properties window will open.
<li><translate><!--T:14-->
#:Alternatively, in the GUI, go to ''Main Selection'' -> ''Tasks'' -> ''By Clients'', select your client and double-click the required backup task.</translate>
Click the '''Options''' tab and under the '''Additional call arguments''' in the '''Save options''' field, enter the desired verbose level in the form: ''-v <No.>''. For example, setting the level to ''-v 3'' will write information on the item's processing into the log file.</translate></li>
#<translate><!--T:14-->
Click the '''Options''' tab. The log level can be set under the ''Additional call arguments''. Click the pencil icon to enable editing this section, and then in the '''Backup options''' or '''Restore options''' fields enter the desired verbose log level in the format: <code>&#8209;v <number></code>. For example, setting the level to <code>&#8209;v 3</code> will log information on the item processing.</translate>
#<translate><!--T:66--> After setting the log level, click '''Save''' to apply the changes and exit edit mode.</translate>


<translate><!--T:15-->
{{note|<translate><!--T:67--> For a new backup task, the log level can be set in the ''Advanced Options'' window of the Backup Configuration Assistant. For details, see [[Special:MyLanguage/Standard_Backup_Procedure|Standard Backup Procedure]].</translate>}}
[[image:Backup_task_log_level.jpg|650px|link=]]</translate>
 
<br clear=all>
{{showMe|screenshot=<translate><!--T:15--> [[image:WebUI_backupTask_settingLogLevel.jpg|800px|link=]]</translate>}}
</ol>
 
<translate>=== Setting log level for restore === <!--T:16-->
=== {{anchor|restore}}<translate><!--T:16-->
Setting log level for restore ===


<!--T:17-->
<!--T:17-->
By default, the log level for restore is set to 1 (''-v 1'') if 1000 or fewer items are selected. You can set the desired log level for each restore operation in its properties:</translate>
By default, the log level for restore is set to 1 (''-v 1'') if 1000 or fewer items are selected. You can change the log level for each restore task in Restore Assistant:</translate>
<ol><li><translate><!--T:18-->
#<translate><!--T:63-->
From the SEP sesam GUI menu bar, select '''Activities''' -> '''Restore'''. The ''New restore task'' window appears.</translate></li>
In the Web UI, navigate to ''Backup Strategy'' -> ''Backup Tasks''. In the line with the required backup task, click the icon for available actions (3 vertical dots), and in the context menu click '''Restore'''. The Restore Assistant opens with the selected task.
<li><translate><!--T:19-->
#:Alternatively, navigate to ''Backup Strategy'' -> ''Restore Tasks''. In the line with the required restore task, click the icon for available actions (3 vertical dots), and in the context menu click '''Immediate start'''. In the ''Settings'' window, click the link ''Create a new restore task...'' to open the task in the Restore Assitant, where it can be modified.</translate>
In the last ''Save and start'' step of the restore wizard, click the '''Expert options''' button. Under the ''Options'' from the '''Verbose level''' drop-down list, select the desired log level for your restore.</translate></li>
#<translate><!--T:19-->
In the ''Options'' window, expand the ''Advanced restore options'' section, and select the required log level in the '''Log level''' drop-down list.</translate>
#<translate><!--T:68--> Continue following the Restore Assistant to start the restore task.</translate>
 
{{showMe|screenshot=<translate><!--T:20--> [[image:RA_settingLogLevel.jpg|800px|link=]]</translate>}}
 
=={{anchor|globalLogLevel}}<translate><!--T:58-->
Setting log level globally for SEP sesam kernel modules in <tt>debug.ini</tt> ==
 
<!--T:59-->
You can configure the log level globally for SEP sesam-specific modules by editing the {{Path|<SESAM_VAR>/ini/debug.ini}} file on the [[Special:MyLanguage/SEP_sesam_Glossary#SEP_sesam_Server|SEP sesam Server]]. It is strongly recommended not to increase the log level unless explicitly instructed to do so by SEP sesam support for troubleshooting purposes.
 
<!--T:60-->
To increase the log level, open the <tt>debug.ini</tt> file on the SEP sesam Server and under the <tt>TRACING</tt> section, set the desired log level (0–6) for the relevant module.  
 
<!--T:61-->
The following log levels are available, listed from least to most detailed:</translate>  
0=ERROR
1=EMERGENCY
2=WARNING
3=NOTICE
4=INFO
5=DEBUG
6=TRACE


<translate><!--T:20-->
<translate><!--T:62--> Once the necessary logs have been captured, it is strongly recommended to revert the log level back to its original setting. Keeping the log level too high may consume excessive disk space and significantly impact SEP sesam performance.</translate>
[[image:Restore_log_level.jpg|550px|link=]]</translate>
<br clear=all>
</ol>


<translate><noinclude>
<noinclude>{{Copyright}}</noinclude>
== See also == <!--T:46-->
[[Special:MyLanguage/SEP_Sesam_CLI|SEP sesam CLI]]</noinclude></translate>

Latest revision as of 13:18, 6 May 2025


How to set a log level

You can control the reporting (verbose) level to define the amount of detail SEP sesam logs in its error reports. By default, the log level is set to 0 for backup and restore, which logs only standard and error messages. Increasing the log level can be helpful for troubleshooting specific issues or when requested by SEP sesam support.

Increasing the log level significantly raises the volume of logged data and may impact SEP sesam performance. You should only raise the log level when investigating a specific issue or when instructed by SEP sesam support. If you modified the log level in the debug.ini file, be sure to revert it to the default value after reproducing the issue and capturing the necessary logs.

The default SEP sesam directory for logs is <SESAM_VAR> (/var/opt/sesam/var). For more information, see Directory Layout.

SEP sesam log levels

SEP sesam uses different log levels for various modules. The following list shows the reporting levels for the backup and restore operations, which can be set individually for each backup or restore task. The log levels are presented in order of increasing verbosity, from the least to the most detailed information logged:

Setting Log level details
0 Logs only standard and error messages, with a summary of key operations and results.
1 This level provides basic progress tracking and logs a line for every item when its processing begins: sbc-3008: Info: Processing item: [xxx]...
2 This level provides feedback on successful completion of individual items and logs a line for every item when its processing completes: sbc-3108: Info: Item processed successfully: [xxx]
3 This level provides detailed information on backup process and logs detailed information about the processing of the backup module, including interactions with the DB_API modules.
4 This level provides detailed view of the internal operations and logs extensive details on underlying module processing, including interactions with XBSA and the DB_API modules.
5 This level provides insight into the data compression and packaging processes and logs packing data trace messages, including details about data formats like mtf, cpio, and sidf.

Setting log level for a task

Setting log level for backup

You can set the desired log level for each backup task in its properties:

  1. In the Web UI, navigate to Backup Strategy -> Backup Tasks, then click on the backup task for which you want to define the log level. The task properties window will open.
    Alternatively, in the GUI, go to Main Selection -> Tasks -> By Clients, select your client and double-click the required backup task.
  2. Click the Options tab. The log level can be set under the Additional call arguments. Click the pencil icon to enable editing this section, and then in the Backup options or Restore options fields enter the desired verbose log level in the format: ‑v <number>. For example, setting the level to ‑v 3 will log information on the item processing.
  3. After setting the log level, click Save to apply the changes and exit edit mode.
Note
For a new backup task, the log level can be set in the Advanced Options window of the Backup Configuration Assistant. For details, see Standard Backup Procedure.

Screenshots

Setting log level for restore

By default, the log level for restore is set to 1 (-v 1) if 1000 or fewer items are selected. You can change the log level for each restore task in Restore Assistant:

  1. In the Web UI, navigate to Backup Strategy -> Backup Tasks. In the line with the required backup task, click the icon for available actions (3 vertical dots), and in the context menu click Restore. The Restore Assistant opens with the selected task.
    Alternatively, navigate to Backup Strategy -> Restore Tasks. In the line with the required restore task, click the icon for available actions (3 vertical dots), and in the context menu click Immediate start. In the Settings window, click the link Create a new restore task... to open the task in the Restore Assitant, where it can be modified.
  2. In the Options window, expand the Advanced restore options section, and select the required log level in the Log level drop-down list.
  3. Continue following the Restore Assistant to start the restore task.

Screenshots

Setting log level globally for SEP sesam kernel modules in debug.ini

You can configure the log level globally for SEP sesam-specific modules by editing the <SESAM_VAR>/ini/debug.ini file on the SEP sesam Server. It is strongly recommended not to increase the log level unless explicitly instructed to do so by SEP sesam support for troubleshooting purposes.

To increase the log level, open the debug.ini file on the SEP sesam Server and under the TRACING section, set the desired log level (0–6) for the relevant module.

The following log levels are available, listed from least to most detailed:

0=ERROR
1=EMERGENCY
2=WARNING
3=NOTICE
4=INFO 
5=DEBUG
6=TRACE

Once the necessary logs have been captured, it is strongly recommended to revert the log level back to its original setting. Keeping the log level too high may consume excessive disk space and significantly impact SEP sesam performance.

Copyright © SEP GmbH (formerly SEP AG) 1999-2025. All rights reserved.
Any form of reproduction of the contents or parts of this manual is allowed only with the express written permission from SEP GmbH. When compiling and designing user documentation SEP GmbH uses great diligence and attempts to deliver accurate and correct information. However, SEP GmbH cannot issue a guarantee for the contents of this manual.