Spade
Mini Shell
<!DOCTYPE html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible"
content="IE=edge,chrome=1" />
<title>LiteSpeed Web Server Users' Manual - Piped
Logger</title>
<meta name="description" content="LiteSpeed Web Server
Users' Manual - Piped Logger." />
<meta name="viewport" content="width=device-width,
initial-scale=1.0" />
<meta name="robots" content="noindex">
<link rel="shortcut icon" href="img/favicon.ico"
/>
<link rel="stylesheet" type="text/css"
href="css/hdoc.css">
</head>
<body>
<div class="pagewrapper clearfix"><aside
class="sidetree ls-col-1-5">
<figure>
<img src="img/lsws_logo.svg" alt="lightspeed web
server logo"
width="100px"/>
</figure>
<h2 class="ls-text-thin">
LiteSpeed Web Server
<br />
<span class="current"><a
href="index.html">Users' Manual</a></span>
</h2>
<h3 class="ls-text-muted">Version 6.3
— Rev. 0</h3>
<hr/>
<div>
<ul>
<li><a href="license.html">License
Enterprise</a></li>
<li><a
href="intro.html">Introduction</a></li>
<li><a
href="install.html">Installation</a></li>
<li>
<a href="admin.html">Administration</a>
<ul class="menu level2">
<li><a href="ServerStat_Help.html">Service
Manager</a></li>
<li><a
href="Real_Time_Stats_Help.html">Real-Time
Stats</a></li>
</ul>
</li>
<li><a
href="security.html">Security</a></li>
<li>
<a href="config.html">Configuration</a>
<ul class="level2">
<li><a href="ServGeneral_Help.html">Server
General</a></li>
<li><a href="ServLog_Help.html">Server
Log</a></li>
<li><a href="ServTuning_Help.html">Server
Tuning</a></li>
<li><a href="ServSecurity_Help.html">Server
Security</a></li>
<li><a href="Cache_Help.html">Page
Cache</a></li>
<li><a
href="PageSpeed_Config.html">PageSpeed
Config</a></li>
<li><a href="ExtApp_Help.html">External
Apps</a></li>
<ul class="level3">
<li><a href="External_FCGI.html">Fast CGI
App</a></li>
<li><a
href="External_FCGI_Auth.html">Fast CGI
Authorizer</a></li>
<li><a href="External_LSAPI.html">LSAPI
App</a></li>
<li><a
href="External_Servlet.html">Servlet
Engine</a></li>
<li><a href="External_WS.html">Web
Server</a></li>
<li><span class="current"><a
href="External_PL.html">Piped
logger</a></span></li>
<li><a href="External_LB.html">Load
Balancer</a></li>
</ul>
<li><a
href="ScriptHandler_Help.html">Script
Handler</a></li>
<li><a
href="PHP_Help.html">PHP</a></li>
<li><a href="App_Server_Help.html">App
Server Settings</a></li>
<li><a
href="Listeners_General_Help.html">Listener
General</a></li>
<li><a
href="Listeners_SSL_Help.html">Listener
SSL</a></li>
<li><a href="Templates_Help.html">Virtual
Host Templates</a></li>
<li><a
href="VirtualHosts_Help.html">Virtual Host
Basic</a></li>
<li><a href="VHGeneral_Help.html">Virtual
Host General</a></li>
<li><a href="VHSecurity_Help.html">Virtual
Host Security</a></li>
<li><a href="VHSSL_Help.html">Virtual Host
SSL</a></li>
<li>
<a href="VHPageSpeed_Config.html">Virtual Host
PageSpeed Config</a>
</li>
<li><a
href="Rewrite_Help.html">Rewrite</a></li>
<li><a
href="Context_Help.html">Context</a></li>
<ul class="level3">
<li><a href="Static_Context.html">Static
Context</a></li>
<li>
<a href="Java_Web_App_Context.html">Java Web
App Context</a>
</li>
<li><a
href="Servlet_Context.html">Servlet
Context</a></li>
<li><a href="FCGI_Context.html">Fast CGI
Context</a></li>
<li><a href="LSAPI_Context.html">LSAPI
Context</a></li>
<li><a href="Proxy_Context.html">Proxy
Context</a></li>
<li><a href="CGI_Context.html">CGI
Context</a></li>
<li><a href="LB_Context.html">Load
Balancer Context</a></li>
<li><a
href="Redirect_Context.html">Redirect
Context</a></li>
<li><a href="App_Server_Context.html">App
Server Context</a></li>
<li><a
href="Rails_Context.html">Rack/Rails
Context</a></li>
</ul>
<li><a
href="VHAddOns_Help.html">Add-ons</a></li>
</ul>
</li>
<li>
<a href="webconsole.html">Web Console</a>
<ul class="level2">
<li><a href="AdminGeneral_Help.html">Admin
Console General</a></li>
<li><a href="AdminSecurity_Help.html">Admin
Console Security</a></li>
<li>
<a href="AdminListeners_General_Help.html">
Admin Listener General
</a>
</li>
<li>
<a href="AdminListeners_SSL_Help.html">Admin
Listener SSL</a>
</li>
</ul>
</li>
</ul>
</div>
</aside>
<article class="contentwrapper ls-col-3-5 clearfix"><div
class="nav-bar ls-spacer-micro-top"><div
class="prev">« <a
href="External_WS.html">Web
Server</a></div><div class="center"><a
href="ExtApp_Help.html">External
Apps</a></div><div class="next"><a
href="External_LB.html">Load Balancer</a>
»</div></div>
<h1>Piped Logger</h1><h2 id="top">Table of
Contents</h2><section class="toc"><section
class="toc-row"><header>Piped
Logger</header><p>
<a href="#extAppName">Name</a> | <a
href="#extAppAddress">Address</a> | <a
href="#maxConns">Max Connections</a> | <a
href="#env">Environment</a> | <a
href="#extAppPath">Command</a> | <a
href="#instances">Instances</a> | <a
href="#extUser">Run As User</a> | <a
href="#extGroup">Run As Group</a> | <a
href="#extUmask">umask</a> | <a
href="#extAppPriority">Priority</a></p></section>
</section>
<section><div class="helpitem"><article
class="ls-helpitem"><div><header
id="extAppName"><h3>Name<span
class="ls-permlink"><a
href="#extAppName"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A
unique name for this external application. You will refer to it by this
name when you use it in other parts of the configuration.</p>
</article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extAppAddress"><h3>Address<span
class="ls-permlink"><a
href="#extAppAddress"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>A
unique socket address used by the external application. IPv4/IPv6 sockets
and Unix Domain Sockets (UDS) are supported. IPv4/IPv6 sockets can be used
for communication over the network. UDS can only be used when the external
application resides on the same machine as the server.</p>
<h4>Syntax</h4><p>IPv4 or IPV6 address:port or
UDS://path</p> <h4>Example</h4><div
class="ls-example">127.0.0.1:5434<br/>
UDS://tmp/lshttpd/php.sock.</div><h4>Tips</h4><p><span
title="Security"
class="ls-icon-security"></span> If the external
application runs on the same machine, UDS is preferred. If you have to use
an IPv4|IPV6 socket, set the IP address to <span
class="val">localhost</span> or <span
class="val">127.0.0.1</span>, so the external
application is inaccessible from other machines.<br/> <span
title="Performance"
class="ls-icon-performance"></span> Unix Domain Sockets
generally provide higher performance than IPv4 sockets.</p>
</article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="maxConns"><h3>Max Connections<span
class="ls-permlink"><a
href="#maxConns"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies
the maximum number of concurrent connections that can be established
between the server and an external application. This setting controls how
many requests can be processed concurrently by an external application,
however, the real limit also depends on the external application itself.
Setting this value higher will not help if the external application is not
fast enough or cannot scale to a large number of concurrent
requests.</p> <h4>Syntax</h4><p>Integer
number</p> <h4>Tips</h4><p><span
title="Performance"
class="ls-icon-performance"></span> Setting a high value
does not directly translate to higher performance. Setting the limit to a
value that will not overload the external application will provide the best
performance/throughput.</p> </article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="env"><h3>Environment<span
class="ls-permlink"><a
href="#env"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies
extra environment variables for the external application.</p>
<h4>Syntax</h4><p>Key=value. Multiple variables can be
separated by "ENTER"</p> </article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extAppPath"><h3>Command<span
class="ls-permlink"><a
href="#extAppPath"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies
the full command line including parameters to execute the external
application. Required value if <span class="tagl"><a
href="#autoStart">Start By Server</a></span> is
enabled. A parameter should be quoted with a double or single quote if the
parameter contains space or tab characters.</p>
<h4>Syntax</h4><p>Full path to the executable with
optional parameters.</p> <h4>See Also</h4><p
class="ls-text-small"><span class="tagl"><a
href="#autoStart">Start By
Server</a></span></p> </article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="instances"><h3>Instances<span
class="ls-permlink"><a
href="#instances"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies
the maximum instances of the external application the server will create.
It is required if <span class="tagl"><a
href="#autoStart">Start By Server</a></span> is
enabled. Most FastCGI/LSAPI applications can only process one request per
process instance and for those types of applications, instances should be
set to match the value of <span class="tagl"><a
href="#maxConns">Max Connections</a></span>. Some
FastCGI/LSAPI applications can spawn multiple child processes to handle
multiple requests concurrently. For these types of applications, instances
should be set to "1" and environment variables used to control
how many child processes the application can spawn.</p>
<h4>Syntax</h4><p>Integer number</p>
</article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extUser"><h3>Run As User<span
class="ls-permlink"><a
href="#extUser"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The
external application will run as this specified user name. If not set,
Virtual Host level settings will be inherited.<br/><br/>
Default value: Not Set</p> <h4>Syntax</h4><p>Valid
username.</p> <h4>See Also</h4><p
class="ls-text-small">extGroup</p> </article>
</div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extGroup"><h3>Run As Group<span
class="ls-permlink"><a
href="#extGroup"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>The
external application will run as this specified group name. If not set,
Virtual Host level settings will be inherited.<br/><br/>
Default value: Not Set</p> <h4>Syntax</h4><p>Valid
group name.</p> <h4>See Also</h4><p
class="ls-text-small">extUser</p> </article>
</div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extUmask"><h3>umask<span
class="ls-permlink"><a
href="#extUmask"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Sets
default umask for this external application's processes. See <span
class="cmd"> man 2 umask </span> for details. The
default value taken from the server-level <span
class="tagl"><a
href="ServSecurity_Help.html#umask">umask</a></span>
setting.</p> <h4>Syntax</h4><p>value valid range
[000]-[777].</p> <h4>See Also</h4><p
class="ls-text-small">CGI <span
class="tagl"><a
href="ServSecurity_Help.html#umask">umask</a></span></p>
</article> </div>
<div class="helpitem"><article
class="ls-helpitem"><div><header
id="extAppPriority"><h3>Priority<span
class="ls-permlink"><a
href="#extAppPriority"></a></span><span
class="top"><a
href="#top">⇑</a></span></h3></header></div><h4>Description</h4><p>Specifies
priority of the external application process. Value ranges from <span
class="val">-20</span> to <span
class="val">20</span>. A lower number means a higher
priority. An external application process cannot have a higher priority
than the web server. If this priority is set to a lower number than the
server's, the server's priority will be used for this
value.</p> <h4>Syntax</h4><p>int</p>
<h4>See Also</h4><p
class="ls-text-small">Server <span
class="tagl"><a
href="ServGeneral_Help.html#serverPriority">Priority</a></span></p>
</article> </div>
</section>
</article><div class="ls-col-1-1"><footer
class="copyright">Copyright © 2003-2020. <a
href="https://www.litespeedtech.com">LiteSpeed Technologies
Inc.</a> All rights reserved.</footer>
</div></div>
</body>
</html>