Submit a ticketCall us
Home > Success Center > Kiwi Syslog Server > Kiwi Syslog Server Documentation > Kiwi Syslog Server Administrator Guide > Add rules, filters, and actions > Add an action > Add an action to run an external program

Add an action to run an external program

Table of contents
No headers

This feature is available only in the licensed version.

You can add an action to run an external program. Details of the message and other Syslog statistics can be passed to the external program as command-line arguments.

A new instance of the external program is launched for every message, so this may become a problem if messages arrive faster than the external program exits. It is especially true if Syslog is installed as a service, in which case the external program is launched by the service inside the non- interactive Windows session. The only way to see that the program is running is by using Task Manager. So if not used carefully this action may lead to the computer being flooded with multiple instances of the external program.

  1. Choose File > Setup to open the Kiwi Syslog Server Setup dialog box.
  2. Add or locate the rule that the action applies to.
  3. Right-click the Actions node below the rule, and choose Add Action.
  4. Replace the default name with a descriptive name. (The name does not have to be unique.)
  5. From the Action menu, select Run external program.

  6. Specify the program file name.

  7. Specify the command line options you would like to pass to the program in the Command line options field.
  8. To pass program variables, counters, script fields and statistics to the external program, click on the Insert message content or counter link and choose an option.
  9. Specify the priority of the new process that will be created.

    Value Priority level Description
    0 Low Specify this class for a process whose threads run only when the system is idle. The threads of the process are preempted by the threads of any process running in a higher priority class. An example is a screen saver. The idle-priority class is inherited by child processes.
    1 BelowNormal Indicates a process that has priority above Idle but below Normal.
    2 Normal (Default value.) Specify this class for a process with no special scheduling needs.
    3 Above Normal Indicates a process that has priority above Normal but below High.
    4 High Specify this class for a process that performs time-critical tasks that must be executed immediately. The threads of the process preempt the threads of normal or idle priority class processes. An example is the Task List, which must respond quickly when called by the user, regardless of the load on the operating system. Use extreme care when using the high-priority class, because a high-priority class application can use nearly all available CPU time.
    5 Realtime

    Specify this class for a process that has the highest possible priority. The threads of the process preempt the threads of all other processes, including operating system processes performing important tasks. For example, a real-time process that executes for more than a very brief interval can cause disk caches not to flush or cause the mouse to be unresponsive.

    Realtime priority can cause system lockups.

  10. If the process has a user interface, specify the Window Mode.

    This setting has no effect on processes that do not have a user interface. This setting is unavailable if you are running Syslog Server as a service.

    If you select Wait for program initialization to complete before continuing, Syslog will wait for the new process to complete its initialization. It does this by waiting until the new process signals that it is idle. This is a blocking operation. Kiwi Syslog will not process messages any further until it receives the InputIdle signal from the process. Because of this, there is an additional option which specifies how long Kiwi Syslog should wait for the process to initialize. Once this time interval has elapsed, Kiwi Syslog assumes that the process started correctly.

    This setting is useful is you are interacting with the process at a later stage, and you want to be sure that the process has started.

  11. (Optional) Test the action.
  12. Click Apply to save the action.
Last modified