Debian Codegraph @

upstream/debian-unstable/man5/bootchart.conf.5

raw
1 '\" t
2 .TH "BOOTCHART\&.CONF" "5" "" "systemd 235" "bootchart.conf"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 bootchart.conf, bootchart.conf.d \- Boot performance analysis graphing tool configuration files
24 .SH "SYNOPSIS"
25 .PP
26 /etc/systemd/bootchart\&.conf
27 .PP
28 /etc/systemd/bootchart\&.conf\&.d/*\&.conf
29 .PP
30 /run/systemd/bootchart\&.conf\&.d/*\&.conf
31 .PP
32 /usr/lib/systemd/bootchart\&.conf\&.d/*\&.conf
33 .SH "DESCRIPTION"
34 .PP
35 When starting, systemd\-bootchart will read the configuration file
36 /etc/systemd/bootchart\&.conf, followed by the files in the
37 bootchart\&.conf\&.d
38 directories\&. These configuration files determine logging parameters and graph output\&.
39 .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE"
40 .PP
41 The default configuration is defined during compilation, so a configuration file is only needed when it is necessary to deviate from those defaults\&. By default, the configuration file in
42 /etc/systemd/
43 contains commented out entries showing the defaults as a guide to the administrator\&. This file can be edited to create local overrides\&.
44 .PP
45 When packages need to customize the configuration, they can install configuration snippets in
46 /usr/lib/systemd/*\&.conf\&.d/\&. Files in
47 /etc/
48 are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. The main configuration file is read before any of the configuration directories, and has the lowest precedence; entries in a file in any configuration directory override entries in the single configuration file\&. Files in the
49 *\&.conf\&.d/
50 configuration subdirectories are sorted by their filename in lexicographic order, regardless of which of the subdirectories they reside in\&. If multiple files specify the same option, the entry in the file with the lexicographically latest name takes precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&.
51 .PP
52 To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to
53 /dev/null
54 in the configuration directory in
55 /etc/, with the same filename as the vendor configuration file\&.
56 .SH "OPTIONS"
57 .PP
58 \fISamples=500\fR
59 .RS 4
60 Configure the amount of samples to record in total before bootchart exits\&. Each sample will record at intervals defined by Frequency=\&.
61 .RE
62 .PP
63 \fIFrequency=25\fR
64 .RS 4
65 Configure the sample log frequency\&. This can be a fractional number, but must be larger than 0\&.0\&. Most systems can cope with values under 25\-50 without impacting boot time severely\&.
66 .RE
67 .PP
68 \fIRelative=no\fR
69 .RS 4
70 Configures whether the left axis of the output graph equals time=0\&.0 (\fBCLOCK_MONOTONIC\fR
71 start)\&. This is useful for using bootchart at post\-boot time to profile an already booted system, otherwise the graph would become extremely large\&. If set to yes, the horizontal axis starts at the first recorded sample instead of time=0\&.0\&.
72 .RE
73 .PP
74 \fIFilter=no\fR
75 .RS 4
76 Configures whether the resulting graph should omit tasks that did not contribute significantly to the boot\&. Processes that are too short\-lived (only seen in one sample) or that do not consume any significant CPU time (less than 0\&.001sec) will not be displayed in the output graph\&.
77 .RE
78 .PP
79 \fIOutput=[path]\fR
80 .RS 4
81 Configures the output directory for writing the graphs\&. By default, bootchart writes the graphs to
82 /run/log\&.
83 .RE
84 .PP
85 \fIInit=[path]\fR
86 .RS 4
87 Configures bootchart to run a non\-standard binary instead of
88 /usr/lib/systemd/systemd\&. This option is only relevant if bootchart was invoked from the kernel command line with init=/usr/lib/systemd/systemd\-bootchart\&.
89 .RE
90 .PP
91 \fIPlotMemoryUsage=no\fR
92 .RS 4
93 If set to yes, enables logging and graphing of processes\*(Aq PSS memory consumption\&.
94 .RE
95 .PP
96 \fIPlotEntropyGraph=no\fR
97 .RS 4
98 If set to yes, enables logging and graphing of the kernel random entropy pool size\&.
99 .RE
100 .PP
101 \fIScaleX=100\fR
102 .RS 4
103 Horizontal scaling factor for all variable graph components\&.
104 .RE
105 .PP
106 \fIScaleY=20\fR
107 .RS 4
108 Vertical scaling factor for all variable graph components\&.
109 .RE
110 .PP
111 \fIControlGroup=no\fR
112 .RS 4
113 Display process control group\&.
114 .RE
115 .PP
116 \fICmdline=no\fR
117 .RS 4
118 Display the full command line of each process\&.
119 .RE
120 .SH "SEE ALSO"
121 .PP
122 \fBsystemd-bootchart\fR(1),
123 \fBsystemd.directives\fR(7)