ocf_heartbeat_syslog-ng(7)

1OCF_HEARTBEAT_SYSLOG(7)       OCF resource agents      OCF_HEARTBEAT_SYSLOG(7)
2
3
4

NAME

6       ocf_heartbeat_syslog-ng - Syslog-ng resource agent
7

SYNOPSIS

9       syslog-ng [start | stop | status | monitor | meta-data | validate-all]
10

DESCRIPTION

12       This script manages a syslog-ng instance as an HA resource.
13
14       For Premium Edition you should set the following parameters (based on
15       default path being "/opt/syslog-ng"):
16       syslog_ng_binary="/opt/syslog-ng/sbin/syslog-ng"
17       syslog_ng_ctl="/opt/syslog-ng/sbin/syslog-ng-ctl"
18       control_file="/opt/syslog-ng/var/run/syslog-ng.ctl"
19       persist_file="/opt/syslog-ng/var/syslog-ng.persist"
20       pidfile="/opt/syslog-ng/var/run/syslog-ng.pid"
21
22       Additional parameter for Premium Edition 6 only:
23       qdisk_dir="/opt/syslog-ng/var/"
24

SUPPORTED PARAMETERS

26       configfile
27           This parameter specifies a configuration file for a syslog-ng
28           instance managed by this RA.
29
30           (required, string, no default)
31
32       syslog_ng_binary
33           This parameter specifies syslog-ng's executable file.
34
35           (optional, string, default "/sbin/syslog-ng")
36
37       syslog_ng_ctl
38           This parameter specifies the path of the syslog-ng-ctl executable
39           file.
40
41           (optional, string, default "/sbin/syslog-ng-ctl")
42
43       qdisk_dir
44           This parameter specifies the directory used for holding disk
45           buffers of syslog-ng (only supported in Premium Edition 6).
46
47           (optional, string, no default)
48
49       control_file
50           This parameter specifies the path, where syslog-ng would place its
51           control socket, through which it can be controlled.
52
53           (optional, string, no default)
54
55       persist_file
56           This parameter specifies the path for syslog-ng's persist file,
57           which holds persistent information about the mapping of
58           destinations and disk buffers, the internal state of sources, etc.
59
60           (optional, string, no default)
61
62       pidfile
63           This parameter specifies the path where the pid file of syslog-ng
64           resides.
65
66           (optional, string, no default)
67
68       start_opts
69           This parameter specifies startup options for a syslog-ng instance
70           managed by this RA. When no value is given, no startup options is
71           used. Don't use option '-F'. It causes a stuck of a start action.
72
73           (optional, string, no default)
74
75       kill_term_timeout
76           On a stop action, a normal stop method(pkill -TERM) is firstly
77           used. And then the confirmation of its completion is waited for the
78           specified seconds by this parameter. The default value is 10.
79
80           (optional, integer, default 10)
81

SUPPORTED ACTIONS

83       This resource agent supports the following actions (operations):
84
85       start
86           Starts the resource. Suggested minimum timeout: 60s.
87
88       stop
89           Stops the resource. Suggested minimum timeout: 120s.
90
91       status
92           Performs a status check. Suggested minimum timeout: 60s.
93
94       monitor
95           Performs a detailed status check. Suggested minimum timeout: 60s.
96           Suggested interval: 60s.
97
98       meta-data
99           Retrieves resource agent metadata (internal use only). Suggested
100           minimum timeout: 5s.
101
102       validate-all
103           Performs a validation of the resource configuration. Suggested
104           minimum timeout: 5s.
105

EXAMPLE CRM SHELL

107       The following is an example configuration for a syslog-ng resource
108       using the crm(8) shell:
109
110           primitive p_syslog-ng ocf:heartbeat:syslog-ng \
111             params \
112               configfile=string \
113             op monitor depth="0" timeout="60s" interval="60s"
114

EXAMPLE PCS

116       The following is an example configuration for a syslog-ng resource
117       using pcs(8)
118
119           pcs resource create p_syslog-ng ocf:heartbeat:syslog-ng \
120             configfile=string \
121             op monitor OCF_CHECK_LEVEL="0" timeout="60s" interval="60s"
122

AUTHOR

127       ClusterLabs contributors (see the resource agent source for information
128       about individual authors)
129
130
131
132resource-agents UNKNOWN           10/11/2023           OCF_HEARTBEAT_SYSLOG(7)