-
Notifications
You must be signed in to change notification settings - Fork 228
/
Copy pathapi-logs-html.html
125 lines (125 loc) · 5.25 KB
/
api-logs-html.html
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
120
121
122
123
124
125
---
layout: guide
---
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>logs.html</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Cockpit Guide">
<link rel="up" href="api-system.html" title="API: system">
<link rel="prev" href="api-system.html" title="API: system">
<link rel="next" href="api-terminal-html.html" title="terminal.html">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="api-system.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="api-system.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Cockpit Guide</th>
<td><a accesskey="n" href="api-terminal-html.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="api-logs-html"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">logs.html</span></h2>
<p>logs.html — System log component</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsection">
<a name="api-logs-html-description"></a><h2>Description</h2>
<pre class="programlisting">
<iframe src="http://127.0.0.1:9090/cockpit+app/@localhost/system/logs.html"
width="600" height="400"></iframe>
</pre>
<p>This is a Cockpit component that brings up system log viewer, with filtering
capabilities. On systemd based systems this displays the entries from journal.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Component URL</span></p></td>
<td><p><code class="code">/cockpit+app/@localhost/system/logs.html</code></p></td>
</tr>
<tr>
<td><p><span class="term">Filter by priority</span></p></td>
<td>
<p><code class="code">#?prio=notice</code></p>
<p>Filters the log to show entries below the specific priority, inclusive. These
<a class="ulink" href="https://en.wikipedia.org/wiki/Syslog#Severity_levels" target="_top">priorities are syslog level keywords</a>.
Specifying <code class="code">*</code> as a priority will show all available entries. The default
priority is <code class="code">err</code>.</p>
</td>
</tr>
<tr>
<td><p><span class="term">Filter by service</span></p></td>
<td>
<p><code class="code">#?service=sshd.service</code></p>
<p>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.</p>
</td>
</tr>
<tr>
<td><p><span class="term">Filter by tag</span></p></td>
<td>
<p><code class="code">#?tag=kernel</code></p>
<p>Filters the log to show entries related to the specific syslog identifier.</p>
</td>
</tr>
<tr>
<td><p><span class="term">Filter by message</span></p></td>
<td>
<p><code class="code">#?grep=</code></p>
<p>Filters the log to show entries where the <code class="code">MESSAGE=</code> field matches the specified regular expression.
PERL-compatible regular expressions are used. If the pattern is all lowercase, matching is case insensitive.
Otherwise, matching is case sensitive.</p>
</td>
</tr>
<tr>
<td><p><span class="term">Filter by any field</span></p></td>
<td>
<p><code class="code">#?FIELD=VALUE</code></p>
<p>A field is referring to the components of a structured journal entry. The match must be exact.
Value can be comma separated list in which case they are automatically matched as alternatives.</p>
</td>
</tr>
<tr>
<td><p><span class="term">Start at point</span></p></td>
<td>
<p><code class="code">#?start=boot</code></p>
<p>Filters the log to show entries after the specific point in time. Valid values
are <code class="code">boot</code> (since last boot), <code class="code">last-24h</code> (last 24 hours),
<code class="code">last-week</code> (last seven days) and <code class="code">previous-boot</code> (previous boot).</p>
</td>
</tr>
<tr>
<td><p><span class="term">Follow the journal</span></p></td>
<td>
<p><code class="code">#?follow=true</code></p>
<p>Keep listening on new entries. Valid values are <code class="code">true</code> (follow) and <code class="code">false</code> (do not follow).</p>
</td>
</tr>
<tr>
<td><p><span class="term">Show log entry</span></p></td>
<td>
<p><code class="code">#/6e272d82993c4e0d...</code></p>
<p>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.</p>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="footer"><hr></div>
</body>
</html>