Skip to content

Commit 03dbb84

Browse files
committed
doc: fix bullet list formatting on logging page
1 parent c340cf1 commit 03dbb84

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc-dev/rst/developers/logging.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,45 @@ Logging
44
=======
55

66
If enabled, the SCR library and the SCR scripts log different events, recording things like:
7+
78
- start time and end time of each application run
89
- time consumed to write each checkpoint/output dataset
910
- time consumed to transfer each dataset from cache to the file system
1011
- any application restarts
1112
- any node failures
1213

1314
This info will let us do various things like:
15+
1416
- gather stats about datasets, including the number of procs used, number of files, and total byte size of each dataset, which could help inform decisions about cache storage requirements for current/future systems
1517
- gather stats about SCR and I/O system performance and variability
1618
- compute stats about application interrupts on a machine
1719
- compute optimal checkpoint frequency for each application. For this, we have a script that parses log entries from the text log file and computes the optimal checkpoint frequency using either the Young or Daly formulas. The goal is to integrate a script like that into the scr_srun script to set an application checkpoint interval more dynamically based on what the application is experiencing on each system: ``scr_ckpt_interval.py``
1820

1921
There are 3 working logging mechanisms. One can use them in any combination in a run:
20-
- text file written to the application’s SCR prefix directory. This is most useful for end users.
21-
- messages written to syslog. This collects log messages from all jobs running on the system, so it’s most useful to system support staff
22+
23+
- text file written to the application's SCR prefix directory. This is most useful for end users.
24+
- messages written to syslog. This collects log messages from all jobs running on the system, so it is most useful to system support staff
2225
- records are written to a MySQL database. This could be used by either an end user or the system support staff. It may be redundant with the other two, but it still works, so I kept it in there. This file has the commands that creates the MySQL database: ``scr.mysql``
2326

2427
Settings
2528
--------
2629

2730
There are settings for each logging mechanism:
28-
- ``SCR_LOG_ENABLE`` - if 0, this disables *all* logging no matter what other settings are. It’s there as an easy way to turn off all logging. If set to 1, then logging depends on other settings below.
31+
32+
- ``SCR_LOG_ENABLE`` - if 0, this disables *all* logging no matter what other settings are. It is there as an easy way to turn off all logging. If set to 1, then logging depends on other settings below.
2933
- Text-based logging:
34+
3035
- ``SCR_LOG_TXT_ENABLE`` - if 1, the text log file is enabled.
36+
3137
- Syslog-based logging:
38+
3239
- ``SCR_LOG_SYSLOG_ENABLE`` - if 1, syslog messages are enabled. There are some associated configure-time settings:
3340
- ``-DSCR_LOG_SYSLOG_FACILITY=[facility]`` : Facility for syslog messages (see man openlog), defaults to ``LOG_LOCAL7``
3441
- ``-DSCR_LOG_SYSLOG_LEVEL=[level]`` : Level for syslog messages (see man openlog), defaults to ``LOG_INFO``
3542
- ``-DSCR_LOG_SYSLOG_PREFIX=[str]`` : Prefix string to prepend to syslog messages, defaults to "SCR"
43+
3644
- MySQL-based logging:
45+
3746
- ``SCR_LOG_DB_ENABLE`` - if 1, mysql logging is enabled
3847
- ``SCR_LOG_DB_DEBUG`` - if 1, echo sql statements to stdout to help when debugging mysql problems
3948
- ``SCR_LOG_DB_HOST`` - host name of mysql server

0 commit comments

Comments
 (0)