mirror of
https://github.com/EnterpriseDB/repmgr.git
synced 2026-03-23 15:16:29 +00:00
1e1b4b1a65
For events generated by these commands, it may be useful to know details of the primary node. This makes following additional parameters available to event notification scripts: - %p: node ID of the primary - %a: node name of the primary - %c: conninfo string for the primary Implements GitHub #375
252 lines
7.5 KiB
Plaintext
252 lines
7.5 KiB
Plaintext
<chapter id="event-notifications" xreflabel="event notifications">
|
|
|
|
<indexterm>
|
|
<primary>event notifications</primary>
|
|
</indexterm>
|
|
|
|
<title>Event Notifications</title>
|
|
<para>
|
|
Each time &repmgr; or <application>repmgrd</application> perform a significant event, a record
|
|
of that event is written into the <literal>repmgr.events</literal> table together with
|
|
a timestamp, an indication of failure or success, and further details
|
|
if appropriate. This is useful for gaining an overview of events
|
|
affecting the replication cluster. However note that this table has
|
|
advisory character and should be used in combination with the &repmgr;
|
|
and PostgreSQL logs to obtain details of any events.
|
|
</para>
|
|
<para>
|
|
Example output after a primary was registered and a standby cloned
|
|
and registered:
|
|
<programlisting>
|
|
repmgr=# SELECT * from repmgr.events ;
|
|
node_id | event | successful | event_timestamp | details
|
|
---------+------------------+------------+-------------------------------+-------------------------------------------------------------------------------------
|
|
1 | primary_register | t | 2016-01-08 15:04:39.781733+09 |
|
|
2 | standby_clone | t | 2016-01-08 15:04:49.530001+09 | Cloned from host 'repmgr_node1', port 5432; backup method: pg_basebackup; --force: N
|
|
2 | standby_register | t | 2016-01-08 15:04:50.621292+09 |
|
|
(3 rows)</programlisting>
|
|
</para>
|
|
<para>
|
|
Alternatively, use <xref linkend="repmgr-cluster-event"> to output a
|
|
formatted list of events.
|
|
</para>
|
|
<para>
|
|
Additionally, event notifications can be passed to a user-defined program
|
|
or script which can take further action, e.g. send email notifications.
|
|
This is done by setting the <literal>event_notification_command</literal> parameter in
|
|
<filename>repmgr.conf</filename>.
|
|
</para>
|
|
<para>
|
|
The following format placeholders are provided for all event notifications:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>%n</option></term>
|
|
<listitem>
|
|
<para>
|
|
node ID
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>%e</option></term>
|
|
<listitem>
|
|
<para>
|
|
event type
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>%s</option></term>
|
|
<listitem>
|
|
<para>
|
|
success (1) or failure (0)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>%t</option></term>
|
|
<listitem>
|
|
<para>
|
|
timestamp
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>%d</option></term>
|
|
<listitem>
|
|
<para>
|
|
details
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<para>
|
|
The values provided for <literal>%t</literal> and <literal>%d</literal>
|
|
will probably contain spaces, so should be quoted in the provided command
|
|
configuration, e.g.:
|
|
<programlisting>
|
|
event_notification_command='/path/to/some/script %n %e %s "%t" "%d"'
|
|
</programlisting>
|
|
</para>
|
|
|
|
<para>
|
|
The following parameters are provided for a subset of event notifications:
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>%p</option></term>
|
|
<listitem>
|
|
<para>
|
|
node ID of the current primary (<xref linkend="repmgr-standby-register"> and <xref linkend="repmgr-standby-follow">)
|
|
</para>
|
|
<para>
|
|
node ID of the demoted primary (<xref linkend="repmgr-standby-switchover"> only)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>%c</option></term>
|
|
<listitem>
|
|
<para>
|
|
<literal>conninfo</literal> string of the primary node
|
|
(<xref linkend="repmgr-standby-register"> and <xref linkend="repmgr-standby-follow">)
|
|
</para>
|
|
<para>
|
|
<literal>conninfo</literal> string of the next available node
|
|
(<varname>bdr_failover</varname> and <varname>bdr_recovery</varname>)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><option>%a</option></term>
|
|
<listitem>
|
|
<para>
|
|
name of the current primary node (<xref linkend="repmgr-standby-register"> and <xref linkend="repmgr-standby-follow">)
|
|
</para>
|
|
<para>
|
|
name of the next available node (<varname>bdr_failover</varname> and <varname>bdr_recovery</varname>)
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
<para>
|
|
The values provided for <literal>%c</literal> and <literal>%a</literal>
|
|
will probably contain spaces, so should always be quoted.
|
|
</para>
|
|
|
|
<para>
|
|
By default, all notification types will be passed to the designated script;
|
|
the notification types can be filtered to explicitly named ones using the
|
|
<varname>event_notifications</varname> parameter:
|
|
|
|
<itemizedlist spacing="compact" mark="bullet">
|
|
|
|
<listitem>
|
|
<simpara><literal>primary_register</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>primary_unregister</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_register</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_register_sync</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_unregister</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_clone</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_promote</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_follow</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_disconnect_manual</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_failure</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>standby_recovery</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>witness_register</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>witness_unregister</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>node_rejoin</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_start</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_shutdown</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_failover_promote</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_failover_follow</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_failover_aborted</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_upstream_disconnect</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_upstream_reconnect</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_promote_error</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>repmgrd_failover_promote</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>bdr_failover</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>bdr_reconnect</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>bdr_recovery</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>bdr_register</literal></simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara><literal>bdr_unregister</literal></simpara>
|
|
</listitem>
|
|
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<para>
|
|
Note that under some circumstances (e.g. when no replication cluster primary
|
|
could be located), it will not be possible to write an entry into the
|
|
<literal>repmgr.events</literal>
|
|
table, in which case executing a script via <varname>event_notification_command</varname>
|
|
can serve as a fallback by generating some form of notification.
|
|
</para>
|
|
|
|
|
|
</chapter>
|