1<refentry id="repmgr-cluster-event">
2  <indexterm>
3    <primary>repmgr cluster event</primary>
4  </indexterm>
5
6  <refmeta>
7    <refentrytitle>repmgr cluster event</refentrytitle>
8  </refmeta>
9
10  <refnamediv>
11    <refname>repmgr cluster event</refname>
12    <refpurpose>output a formatted list of cluster events</refpurpose>
13  </refnamediv>
14
15  <refsect1>
16    <title>Description</title>
17
18    <para>
19      Outputs a formatted list of cluster events, as stored in the <literal>repmgr.events</literal> table.
20    </para>
21  </refsect1>
22
23  <refsect1>
24    <title>Usage</title>
25
26    <para>
27      Output is in reverse chronological order, and
28      can be filtered with the following options:
29      <itemizedlist spacing="compact" mark="bullet">
30        <listitem>
31          <simpara><literal>--all</literal>: outputs all entries</simpara>
32        </listitem>
33        <listitem>
34          <simpara><literal>--limit</literal>: set the maximum number of entries to output (default: 20)</simpara>
35        </listitem>
36        <listitem>
37          <simpara><literal>--node-id</literal>: restrict entries to node with this ID</simpara>
38        </listitem>
39        <listitem>
40          <simpara><literal>--node-name</literal>: restrict entries to node with this name</simpara>
41        </listitem>
42        <listitem>
43          <simpara><literal>--event</literal>: filter specific event (see <xref linkend="event-notifications"/> for a full list)</simpara>
44        </listitem>
45      </itemizedlist>
46    </para>
47    <para>
48      The &quot;Details&quot; column can be omitted by providing <literal>--compact</literal>.
49    </para>
50  </refsect1>
51
52  <refsect1>
53    <title>Output format</title>
54    <para>
55      <itemizedlist spacing="compact" mark="bullet">
56
57        <listitem>
58          <simpara>
59            <literal>--csv</literal>: generate output in CSV format. Note that the <literal>Details</literal>
60            column will currently not be emitted in CSV format.
61          </simpara>
62        </listitem>
63
64      </itemizedlist>
65    </para>
66  </refsect1>
67
68  <refsect1>
69    <title>Example</title>
70    <para>
71      <programlisting>
72    $ repmgr -f /etc/repmgr.conf cluster event --event=standby_register
73     Node ID | Name  | Event            | OK | Timestamp           | Details
74    ---------+-------+------------------+----+---------------------+-------------------------------------------------------
75     3       | node3 | standby_register | t  | 2019-04-16 10:59:59 | standby registration succeeded; upstream node ID is 1
76     2       | node2 | standby_register | t  | 2019-04-16 10:59:57 | standby registration succeeded; upstream node ID is 1</programlisting>
77    </para>
78  </refsect1>
79</refentry>
80