Debian Codegraph @

upstream/opensuse-tumbleweed/man1/systemd-report.1

raw
1 '\" t
2 .TH "SYSTEMD\-REPORT" "1" "" "systemd 260.1" "systemd-report"
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 systemd-report \- Generate report of system facts and metrics
24 .SH "SYNOPSIS"
25 .HP \w'\fBsystemd\-report\fR\ 'u
26 \fBsystemd\-report\fR [OPTIONS...]
27 .SH "DESCRIPTION"
28 .PP
29 \fINote: this command is experimental for now\&. While it is likely to become a regular component of systemd, it might still change in behaviour and interface\&.\fR
30 .PP
31 \fBsystemd\-report\fR
32 requests facts and metrics from the system and writes them to standard output\&.
33 .SH "COMMANDS"
34 .PP
35 The following commands are understood:
36 .PP
37 \fBmetrics\fR [MATCH...]
38 .RS 4
39 Acquire a list of metrics values from all local services providing them, and write them to standard output\&. Optionally takes one or more match expressions for filtering the metrics to show\&. The expression either may be a literal metric family name to search for, or a prefix of one (which will be matched only at dot boundaries)\&. If multiple matches are specified as multiple parameters, any metric matching
40 \fIany\fR
41 of the specified matches are shown\&.
42 .sp
43 Added in version 260\&.
44 .RE
45 .PP
46 \fBdescribe\-metrics\fR [MATCH...]
47 .RS 4
48 Acquire a list of metric families from all local services providing them, and write them to standard output\&. This returns primarily static information about metrics, their data types and human readable description, without values\&.
49 .sp
50 Match expressions similar to those supported by
51 \fBmetrics\fR
52 are supported for
53 \fBdescribe\-metrics\fR, too\&.
54 .sp
55 Added in version 260\&.
56 .RE
57 .PP
58 \fBlist\-sources\fR
59 .RS 4
60 Show list of known metrics sources\&.
61 .sp
62 Added in version 260\&.
63 .RE
64 .SH "OPTIONS"
65 .PP
66 The following options are understood:
67 .PP
68 \fB\-\-system\fR, \fB\-\-user\fR
69 .RS 4
70 Query per\-system metrics sources (the default), or the per\-user metrics sources\&.
71 .sp
72 Added in version 260\&.
73 .RE
74 .PP
75 \fB\-\-no\-pager\fR
76 .RS 4
77 Do not pipe output into a pager\&.
78 .RE
79 .PP
80 \fB\-\-json=\fR\fB\fIMODE\fR\fR
81 .RS 4
82 Shows output formatted as JSON\&. Expects one of
83 "short"
84 (for the shortest possible output without any redundant whitespace or line breaks),
85 "pretty"
86 (for a pretty version of the same, with indentation and line breaks) or
87 "off"
88 (to turn off JSON output, the default)\&.
89 .RE
90 .PP
91 \fB\-j\fR
92 .RS 4
93 Equivalent to
94 \fB\-\-json=pretty\fR
95 if running on a terminal, and
96 \fB\-\-json=short\fR
97 otherwise\&.
98 .RE
99 .PP
100 \fB\-\-no\-legend\fR
101 .RS 4
102 Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
103 .RE
104 .PP
105 \fB\-h\fR, \fB\-\-help\fR
106 .RS 4
107 Print a short help text and exit\&.
108 .RE
109 .PP
110 \fB\-\-version\fR
111 .RS 4
112 Print a short version string and exit\&.
113 .RE
114 .SH "EXIT STATUS"
115 .PP
116 On success, 0 is returned, a non\-zero failure code otherwise\&.
117 .SH "SEE ALSO"
118 .PP
119 \fBsystemd\fR(1)