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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
<refentry id="APP-GTM-PROXY">
<indexterm zone="app-gtm-proxy">
<primary>gtm_proxy</primary>
</indexterm>
<refmeta>
<refentrytitle>gtm_proxy</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gtm_proxy</refname>
<refpurpose>
Proxy to <command>gtm</command>, <productname>Postgres-XL</productname> Global Transaction Manager
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>gtm_proxy</command>
<arg rep="repeat"><replaceable>option</></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-GTM-PROXY-1">
<title>
Description
</title>
<para>
The Gtm proxy provides proxy feature from Postgres-XL Coordinator and
Datanode to gtm. Gtm proxy groups connections and interactions
between gtm and other Postgres-XL components to reduce both the
number of interactions and the size of messages. Performance tests
have shown greater performance with high concurrency workloads as a result.
</para>
<para>
It is highly advised to start and stop gtm_proxy with gtm_ctl(8).
</para>
<para>
You must provide a gtm configuration
file <filename>gtm_proxy.conf</filename> placed at the gtm working directory
as specified by <literal>-D</literal> command line option. The
configuration file specifies gtm running environment and resources.
</para>
<para>
Some of the parameters specified in the control file can be overridden by
command line options.
</para>
</refsect1>
<refsect1>
<title>Configuration File</title>
<para>
<literal>GTM-Proxy</literal> configuration parameters are specified in the configuration file
<filename>gtm_proxy.conf</filename><indexterm><primary>gtm_proxy.conf</></> placed in the working directory
specified as <literal>-D</literal> option
of <application>gtm_proxy</application> command line option as described
in the next section.
</para>
<para>
The format of the configuration file is the same as <filename>postgresql.conf</filename>.
Options are as follows.
</para>
<!-- Add description of each gtm.conf entry -->
<!-- Notice
The following options are found in the source code (gtm_opt.c) but is only for
internal use and will not be presented in the following list.
1. data_dir
2. config_file
Also the following options are for high-availability hook. This will be
documented later.
1. error_reporter
2. status_reader
-->
<variablelist>
<varlistentry id="gtm-proxy-opt-gtm-connect-retry-interval" xreflabel="gtm_proxy_opt_gtm_connect_retry_interval">
<term><varname>gtm_connect_retry_interval</varname> (<type>integer</type>)
<indexterm>
<primary><varname>gtm_connect_retry_interval</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies how long in seconds GTM-Proxy waits between each retry to connect to GTM when
communication error with GTM is detected.
Default value is 60.
Refer to <varname>gtm_connect_retry_count</varname> and <varname>gtm_connect_retry_idle</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-gtm-host" xreflabel="gtm_proxy_opt_gtm_host">
<term><varname>gtm_host</varname> (<type>string</type>)
<indexterm>
<primary><varname>gtm_host</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies listen addresses (host name or IP address) of <application>gtm</application>.
There is no default value for this parameter.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-gtm-port" xreflabel="gtm_proxy_opt_gtm_port">
<term><varname>gtm_port</varname> (<type>integer</type>)
<indexterm>
<primary><varname>gtm_port</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies the port number of <application>gtm</application>.
There is no default value for this parameter.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-keepalives-count" xreflabel="gtm_proxy_opt_keepalives_count">
<term><varname>keepalives_count</varname> (<type>integer</type>)
<indexterm>
<primary><varname>keepalives_count</varname> (<type>integer</type>)</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies <literal>keepalives_count</literal> option for the
connection to <application>gtm</application>.
Default value is zero and keepalives feature is disabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-keepalives-idle" xreflabel="gtm_proxy_opt_keepalives_idle">
<term><varname>keepalives_idle</varname> (<type>integer</type>)
<indexterm>
<primary><varname>keepalives_idle</varname> (<type>integer</type>)</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies <literal>keepalives_idle</literal> option for the
connection to <application>gtm</application>.
Default value is zero and keepalives feature is disabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-keepalives-interval" xreflabel="gtm_proxy_opt_keepalives_interval">
<term><varname>keepalives_interval</varname> (<type>integer</type>)
<indexterm>
<primary><varname>keepalives_interval</varname> (<type>integer</type>)</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies <literal>keepalives_interval</literal> option for the
connection to <application>gtm</application>.
Default value is zero and keepalives feature is disabled.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-log-file" xreflabel="gtm_proxy_opt_log_file">
<term><varname>log_file</varname> (<type>string</type>)
<indexterm>
<primary><varname>log_file</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies <filename>log</filename> file name. This file will be
created in the working directory of
this <application>gtm_proxy</application> as specified
by <literal>-D</literal> command line option.
The default is <filename>gtm_proxy.log</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-log-min-messages" xreflabel="gtm_proxy_opt_log_min_messages">
<term><varname>log_min_messages</varname> (<type>enum</type>)
<indexterm>
<primary><varname>log_min_messages</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Controls which message levels are written to the log.
Valid values are <literal>DEBUG</literal>, <literal>DEBUG5</literal>,
<literal>DEBUG4</literal>, <literal>DEBUG3</literal>, <literal>DEBUG2</literal>,
<literal>DEBUG1</literal>, <literal>INFO</literal>, <literal>NOTICE</literal>,
<literal>WARNING</literal>, <literal>ERROR</literal>, <literal>LOG</literal>,
<literal>FATAL</literal> and <literal>PANIC</literal>.
Each level includes all the levels that follow it.
The later the level, the fewer messages are sent.
The default is <literal>WARNING</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-listen-addresses" xreflabel="gtm_proxy_opt_listen_addresses">
<term><varname>listen_addresses</varname> (<type>string</type>)
<indexterm>
<primary><varname>listen_addresses</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies listen addresses (host name or IP address) of
this <application>gtm_proxy</application>.
Default value is '*'.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-nodename" xreflabel="gtm_proxy_opt_nodename">
<term><varname>nodename</varname> (<type>string</type>)
<indexterm>
<primary><varname>nodename</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies the name of this <application>gtm_proxy</application>.
There is no default value for this parameter.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-port" xreflabel="gtm_proxy_opt_port">
<term><varname>port</varname> (<type>integer</type>)
<indexterm>
<primary><varname>port</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies the port number of this <application>gtm_proxy</application>.
The default port value is 6666.
</para>
</listitem>
</varlistentry>
<varlistentry id="gtm-proxy-opt-worker-threads" xreflabel="gtm_proxy_opt_worker_threads">
<term><varname>worker_threads</varname> (<type>integer</type>)
<indexterm>
<primary><varname>worker_threads</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
<para>
Specifies the number of worker threads for this <literal>gtm_proxy</literal>.
The default value is 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Options</title>
<para>
Options are specified with preceding '<literal>-</literal>', each
option may be associated with a value. They can be specified
in <literal>-o</literal> option of gtm_ctl(8).
</para>
<para>
Options are as follows:
</para>
<para>
<variablelist>
<varlistentry>
<term><option>D</option></term>
<listitem>
<para>
Specify a directory which holds data for <command>gtm_proxy</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>l</option></term>
<listitem>
<para>
Specify a log file for <command>gtm_ctl</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>h</option></term>
<listitem>
<para>
Specify host name or IP address used by the <command>gtm_proxy</command>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>p</option></term>
<listitem>
<para>
Specify port number to listen on.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>i</option></term>
<listitem>
<para>
Specify gtm_proxy id, which is registered to gtm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>n</option></term>
<listitem>
<para>
Specify number of worker threads of gtm_proxy.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>s</option></term>
<listitem>
<para>
Specify host name or IP address of target gtm.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>t</option></term>
<listitem>
<para>
Specify port number of target gtm.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
|