I2Rest with syslog - Revision history

Alexei.baranov at 07:23, 12 July 2021

2021-07-12T07:23:07Z

Alexei.baranov at 06:40, 8 July 2020

2020-07-08T06:40:59Z

Pavel.lobko at 13:31, 6 July 2020

2020-07-06T13:31:05Z

Pavel.lobko at 13:30, 6 July 2020

2020-07-06T13:30:40Z

Alexei.baranov: Created page with "{{DISPLAYTITLE:Using syslog with i2Rest Server}} Depending on defined DEBUG level, i2Rest Server can produce a lot of messages. These messages can be sent to stdout or to [ht..."

2020-06-12T10:07:14Z

Created page with "{{DISPLAYTITLE:Using syslog with i2Rest Server}} Depending on defined DEBUG level, i2Rest Server can produce a lot of messages. These messages can be sent to stdout or to [ht..."

New page

{{DISPLAYTITLE:Using syslog with i2Rest Server}}

Depending on defined DEBUG level, i2Rest Server can produce a lot of messages. These messages can be sent to stdout or to [https://en.wikipedia.org/wiki/Syslog syslog server]. Using syslog allows you to centralize the collection and processing of messages from different sources, as well as routing messages to other syslog servers. 
= Local syslog server =
i2Rest Server can send messages to local or remote syslog server. It is possible to start local syslog server on local IBM i server. 
IBM i PASE includes standalone syslogd server, that can be used as a starting point to process syslog messages from i2Rest Server. You can find detailed information how to start syslogd daemon on IBM i [https://www.ibm.com/support/knowledgecenter/ssw_aix_71/s_commands/syslogd.html here]. 
To simplify the task of starting the server, we prepared the following brief instructions:

# Prepare file syslog.conf and put it on IFS folder, for example at /usr/i2rest/syslog.conf. Enter following text in syslog.conf (you can change path and name of syslog.out to other desired value):
#:<code>*.debug /usr/i2rest/syslog.out rotate size 500k time 1d</code>
# Create file to store syslog messages, don't forget to enter correct name of syslog.conf file:
#:<code>STRQSH CMD('touch /usr/i2rest/syslog.conf')</code>
# Submit syslogd daemon with following command:
#:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f/usr/i2rest/syslog.conf')) ALWMLTTHD(*YES)</code>

With these settings, the local syslog server will be launched. The server will listen to calls to port 514 and will save messages in file /usr/i2rest/syslog.out. The file will be recreated when it reaches 500k or once a day. Archived copies will be kept at /usr/i2rest. 
You can use one syslog server for several i2Rest Server instances. If required, you can setup rules for routing messages to other syslog servers in syslog.conf.

= i2Rest Server settings for syslog =
Setting up i2Rest Server to work with syslog is quite simple - just specify the server address in the [[I2Rest_Config#syslog|configuration file]], parameter "syslog":
<pre>
{
...
"debug" : 7, "syslog":"udp://localhost:514",
...
}</pre>
You can use different syslog server settings for each i2Rest Server gate - see details in [[Gate_object#syslog|gate object]]

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Using syslog with i2Rest Server}}
-Depending on defined DEBUG level, i2Rest Server can produce a lot of messages. These messages can be sent to stdout or to [https://en.wikipedia.org/wiki/Syslog syslog server]. Using syslog allows you to centralize the collection and processing of messages from different sources, as well as routing messages to other syslog servers.<br/>
+Depending on defined DEBUG level, i2Rest Server can produce a lot of messages. These messages can be sent to <code>stdout</code> or to [https://en.wikipedia.org/wiki/Syslog syslog server]. Using syslog allows you to centralize the collection and processing of messages from different sources, as well as routing messages to other syslog servers.<br/>
 = Local syslog server =
 i2Rest Server can send messages to local or remote syslog server. It is possible to start local syslog server on local IBM i server.<br/>
@@ Line 9: / Line 9: @@
 # Prepare file syslog.conf and put it on IFS folder, for example at /usr/i2rest/syslog.conf. Enter following text in syslog.conf (you can change path and name of syslog.out to other desired value):
 #:<code>*.debug '''/usr/i2rest/syslog.out''' rotate size 500k time 1d</code>
-# Create file to store syslog messages, don't forget to enter correct name of syslog.conf file:
+# Create file to store syslog messages, don't forget to enter correct name of syslog.out file:
-#:<code>STRQSH CMD('touch '''/usr/i2rest/syslog.conf'''<nowiki>'</nowiki>)</code>
+#:<code>STRQSH CMD('touch '''/usr/i2rest/syslog.out'''<nowiki>'</nowiki>)</code>
 # Submit syslogd daemon with following command:
 #:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f'''/usr/i2rest/syslog.conf'''<nowiki>'</nowiki>)) ALWMLTTHD(*YES)</code>

@@ Line 12: / Line 12: @@
 #:<code>STRQSH CMD('touch '''/usr/i2rest/syslog.conf'''<nowiki>'</nowiki>)</code>
 # Submit syslogd daemon with following command:
-#:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f'''/usr/i2rest/syslog.conf'''nowiki>'</nowiki>)) ALWMLTTHD(*YES)</code>
+#:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f'''/usr/i2rest/syslog.conf'''<nowiki>'</nowiki>)) ALWMLTTHD(*YES)</code>
 With these settings, the local syslog server will be launched. The server will listen to calls to port 514 and will save messages in file /usr/i2rest/syslog.out. The file will be recreated when it reaches 500k or once a day. Archived copies will be kept at /usr/i2rest.<br/>

@@ Line 8: / Line 8: @@
 # Prepare file syslog.conf and put it on IFS folder, for example at /usr/i2rest/syslog.conf. Enter following text in syslog.conf (you can change path and name of syslog.out to other desired value):
-#:<code>*.debug <span style="color:red;">/usr/i2rest/syslog.out</span> rotate size 500k time 1d</code>
+#:<code>*.debug '''/usr/i2rest/syslog.out''' rotate size 500k time 1d</code>
 # Create file to store syslog messages, don't forget to enter correct name of syslog.conf file:
-#:<code>STRQSH CMD('touch <span style="color:red;">/usr/i2rest/syslog.conf</span>')</code>
+#:<code>STRQSH CMD('touch '''/usr/i2rest/syslog.conf'''<nowiki>'</nowiki>)</code>
 # Submit syslogd daemon with following command:
-#:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f<span style="color:red;">/usr/i2rest/syslog.conf</span>')) ALWMLTTHD(*YES)</code>
+#:<code>SBMJOB CMD(CALL PGM(QP2SHELL) PARM('/QIBM/ProdData/OS400/PASE/sbin/syslogd' '-a' '-n' '-f'''/usr/i2rest/syslog.conf'''nowiki>'</nowiki>)) ALWMLTTHD(*YES)</code>
 With these settings, the local syslog server will be launched. The server will listen to calls to port 514 and will save messages in file /usr/i2rest/syslog.out. The file will be recreated when it reaches 500k or once a day. Archived copies will be kept at /usr/i2rest.<br/>

@@ Line 16: / Line 16: @@
 With these settings, the local syslog server will be launched. The server will listen to calls to port 514 and will save messages in file /usr/i2rest/syslog.out. The file will be recreated when it reaches 500k or once a day. Archived copies will be kept at /usr/i2rest.<br/>
 You can use one syslog server for several i2Rest Server instances. If required, you can setup rules for routing messages to other syslog servers in syslog.conf.
 = i2Rest Server settings for syslog =