1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<?xml version="1.0"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<reference id="api-system">
<title>API: system</title>
<partintro>
<para>This package contains general components for basic control of a system.</para>
</partintro>
<refentry id="api-logs-html">
<refmeta>
<refentrytitle>logs.html</refentrytitle>
</refmeta>
<refnamediv>
<refname>logs.html</refname>
<refpurpose>System log component</refpurpose>
</refnamediv>
<refsection id="api-logs-html-description">
<title>Description</title>
<programlisting>
<iframe src="http://127.0.0.1:9090/cockpit+app/@localhost/system/logs.html"
width="600" height="400"></iframe>
</programlisting>
<para>This is a Cockpit component that brings up system log viewer, with filtering
capabilities. On systemd based systems this displays the entries from journal.</para>
<variablelist>
<varlistentry>
<term>Component URL</term>
<listitem><para><code>/cockpit+app/@localhost/system/logs.html</code></para></listitem>
</varlistentry>
<varlistentry>
<term>Filter by priority</term>
<listitem>
<para><code>#?prio=5</code></para>
<para>Filters the log to show entries below the specific priority, inclusive. These
<ulink url="https://en.wikipedia.org/wiki/Syslog#Severity_levels">priorities are syslog levels</ulink>.
Specifying <code>*</code> as a priority will show all available entries. The default
priority is <code>3</code>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filter by service</term>
<listitem>
<para><code>#?service=sshd.service</code></para>
<para>Filters the log to show entries related to the specific service. The format of
the service is specific to the logging implementation. For journald these are systemd
service unit names.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Filter by tag</term>
<listitem>
<para><code>#?tag=kernel</code></para>
<para>Filters the log to show entries related to the specific syslog identifier.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Start at point</term>
<listitem>
<para><code>#?start=boot</code></para>
<para>Filters the log to show entries after the specific point in time. Valid values
are <code>boot</code> (since last boot), <code>last-24h</code> (last 24 hours),
<code>last-week</code> (last seven days).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Show log entry</term>
<listitem>
<para><code>#/6e272d82993c4e0d...</code></para>
<para>To show a specific log entry, put the log entry cursor in a path after
the hash above. Note that cursors are logging system specific, and journal
cursors are subject to change.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
</refentry>
<refentry id="api-terminal-html">
<refmeta>
<refentrytitle>terminal.html</refentrytitle>
</refmeta>
<refnamediv>
<refname>terminal.html</refname>
<refpurpose>Server terminal component</refpurpose>
</refnamediv>
<refsection id="api-terminal-html-description">
<title>Description</title>
<programlisting>
<iframe src="http://127.0.0.1:9090/cockpit+app/@localhost/system/terminal.html"
width="600" height="400"></iframe>
</programlisting>
<para>This is a Cockpit component that brings up a web-based terminal for
the logged in user.</para>
<variablelist>
<varlistentry>
<term>Component URL</term>
<listitem><para><code>/cockpit+app/@localhost/system/terminal.html</code></para></listitem>
</varlistentry>
</variablelist>
</refsection>
</refentry>
</reference>
|
