Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

executable file 267 lines (177 sloc) 8.011 kB
#!/usr/bin/perl
use strict;
use Plack::Runner;
sub version {
require Starman;
print "Starman $Starman::VERSION\n";
}
my $preload_app;
require Getopt::Long;
Getopt::Long::Configure("no_ignore_case", "no_auto_abbrev", "pass_through");
Getopt::Long::GetOptions(
"preload-app" => \$preload_app,
);
my @args = (server => 'Starman', env => 'deployment', version_cb => \&version);
if (!$preload_app) {
push @args, 'loader' => 'Delayed';
}
my @argv = @ARGV;
my $runner = Plack::Runner->new(@args);
$runner->parse_options(@argv);
$runner->set_options(argv => \@argv);
$runner->run;
__END__
=head1 NAME
starman - Starman launcher
=head1 SYNOPSIS
starman --listen :5001 --listen /tmp/starman.sock
starman --workers 32 --port 8080
=head1 OPTIONS
=over 4
=item -l, --listen
--listen HOST:PORT --listen :PORT --listen UNIX_SOCKET
Specifies the TCP address, ports and UNIX domain sockets to bind to
wait for requests. You can repeat as many times as you want and mix
TCP and UNIX domain sockets.
Defaults to any IP address and port 5000.
=item --host
--host 127.0.0.1
Specifies the address to bind.
This option is for a compatiblity with L<plackup> and you're
recommended to use C<--listen> instead.
=item --port
--port 8080
Specifies the port to bind.
This option is for a compatiblity with L<plackup> and you're
recommended to use C<--listen> instead.
=item -S, --socket
-S /tmp/starman.sock
Specifies the path to UNIX domain socket to bind.
This option is for a compatiblity with L<plackup> and you're
recommended to use C<--listen> instead.
=item --workers
Specifies the number of worker pool. Defaults to 5.
Starman by default sets up other spare server configuration based on this
workers value, making sure there are B<always only> C<N> worker
processes running. So even if there're no idle workers, Starman won't
spawn off spare processes since that's mostly what you want to do by
fine tuning the memory usage etc. in the production environment.
=item --backlog
Specifies the number of backlog (listen queue size) of listener sockets. Defaults to 1024.
On production systems, setting a very low value can allow failover on
frontend proxy (like nginx) to happen more quickly, if you have
multiple Starman clusters.
If you're doing simple benchmarks and getting connection errors,
increasing this parameter can help avoid them. You should also
consider increasing C<net.core.somaxconn>. Note that this is not
recommended for real production system if you have another cluster to
failover (see above).
=item --max-requests
Number of the requests to process per one worker process. Defaults to 1000.
=item --preload-app
This option lets Starman preload the specified PSGI application in the
master parent process before preforking children. This allows memory
savings with copy-on-write memory management. When not set (default),
forked children loads the application in the initialization hook.
Enabling this option can cause bad things happen when resources like
sockets or database connections are opened at load time by the master
process and shared by multiple children.
Since Starman 0.2000, this option defaults to false, and you should
explicitly set this option to preload the application in the master
process.
Alternatively, you can use -M command line option (plackup's common
option) to preload the I<modules> rather than the <application>
itself.
starman -MCatalyst -MDBIx::Class myapp.psgi
will load the modules in the master process for memory savings with
CoW, but the actual loading of C<myapp.psgi> is done per children,
allowing resource managements such as database connection safer.
If you enable this option, sending C<HUP> signal to the master process
I<will not> pick up any code changes you make. See L</SIGNALS> for
details.
=item --disable-keepalive
Disable Keep-alive persistent connections. It is an useful workaround
if you run Starman behind a broken frontend proxy that tries to pool
connections more than a number of backend workers (i.e. Apache
mpm_prefork + mod_proxy).
=item --keepalive-timeout
The number of seconds Starman will wait for a subsequent request
before closing the connection if Keep-alive persistent connections
are enabled. Setting this to a high value may cause performance
problems in heavily loaded servers. The higher the timeout, the
more backend workers will be kept occupied waiting on connections
with idle clients.
Defaults to 1.
=item --user
To listen on a low-numbered (E<lt>1024) port, it will be necessary to
start the server as root. Use the C<--user> option to specify a userid
or username that the server process should switch to after binding to
the port.
Defaults to the current userid.
=item --group
Specify the group id or group name that the server should switch to after
binding to the port. This option is usually used with C<--user>.
Defaults to the current group id.
=item --pid
Specify the pid file path. Use it with C<-D|--daemonize> option,
described in C<plackup -h>.
=item --error-log
Specify the pathname of a file where the error log should be written.
This enables you to still have access to the errors when using C<--daemonize>.
=back
Starman passes through other options given to L<Plack::Runner>, the
common backend that L<plackup> uses, so the most options explained in
C<plackup -h> such as C<--access-log> or C<--daemonize> works fine in
starman too.
Setting the environment variable C<STARMAN_DEBUG> to 1 makes the
Starman server runninng in the debug mode.
=cut
=head1 SIGNALS
=over 4
=item HUP
Sending C<HUP> signal to the master process will restart all the workers
gracefully (meaning the currently running requests will shut down once
the request is complete), and by default, the workers will pick up the
code changes you make by reloading the application.
If you enable C<--preload-app> option, however, the code will be only
loaded in the startup process and will not pick up the code changes
you made. If you want to preload the app I<and> do graceful restarts
by reloading the code changes, you're recommended to use
L<Server::Starter>, configured to send C<QUIT> signal when superdaemon
received C<HUP>, i.e:
start_server --interval 5 --port 8080 --signal-on-hup=QUIT -- \
starman --preload-app myapp.psgi
You will then send the HUP signal to C<start_server> process to
gracefully reload the starman cluster (master and workers).
With Server::Starter 0.12 or later, you should also be able to set
C<--signal-on-term> to QUIT so that you can safely shutdown Starman
first and then stop the C<start_server> daemon process as well.
=item TTIN, TTOU
Sending C<TTIN> signal to the master process will dynamically increase
the number of workers, and C<TTOU> signal will decrease it.
=item INT, TERM
Sending C<INT> or C<TERM> signal to the master process will kill all
the workers immediately and shut down the server.
=item QUIT
Sending C<QUIT> signal to the master process will gracefully shutdown
the workers (meaning the currently running requests will shut down
once the request is complete).
=back
=head1 RELOADING THE APPLICATION
You're recommended to use signals (see above) to reload the
application, and are strongly discouraged to use C<-r> or C<-R>
(reloading flag) from plackup. These options will make a separate
directory watcher thread, and makes your life difficult if you want to
combine with other process daemon tools such as Server::Strater.
=head1 DIFFERENCES WITH PLACKUP
C<starman> executable is basically the equivalent of using C<plackup>
with C<Starman> server handler i.e. C<plackup -s Starman>, except that
C<starman> delay loads the application with the Delayed loader by
default, which can be disabled with C<--preload-app>.
C<starman> command also automatically sets the environment (C<-E>) to
the value of I<deployment>.
You're recommended to use C<starman> unless there's a reason to stick to
C<plackup> for compatiblity.
=head1 SEE ALSO
L<Starman>
=cut
Jump to Line
Something went wrong with that request. Please try again.