<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book [
<!ENTITY % tnt SYSTEM "../tnt.ent">
%tnt;
]>
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0"
      xmlns:xlink="http://www.w3.org/1999/xlink"
      xml:id="proctitle">

<title>Server process titles</title>

<para>
  Linux and FreeBSD operating systems allow a running process to
  modify its title, which otherwise contains the program name.
  Tarantool uses this feature to help meet the needs of system
  administration, such as figuring out what services are running
  on a host, what TCP/IP ports are in use, and so on.
</para>
<para>
  Tarantool process title follows the following naming scheme:
  <command><replaceable>program_name</replaceable>: <replaceable>role</replaceable>[@<olink targetptr="custom_proc_title"/>] [ports in use]</command>
</para>
<para>
  <emphasis role="strong">program_name</emphasis> is typically
  <command>tarantool_box</command>. The role can be one of the
  following:
  <itemizedlist>
    <listitem><para>
      <emphasis role="strong">primary</emphasis> -- the master node,
    </para></listitem>
    <listitem><para>
      <emphasis role="strong">replica/<constant>IP</constant>:<constant>port</constant></emphasis> -- a replication node,
    </para></listitem>
    <listitem><para>
      <emphasis role="strong">replication_server </emphasis>--
      runs only if <olink targetptr="replication_port"/> is set,
      accepts connections on this port and creates a 
    </para></listitem>
    <listitem><para>
      <emphasis role="strong">replication_relay </emphasis>-- a
      process that servers a single replication connection.
    </para></listitem>
  </itemizedlist>
  Possible port names are: <quote>pri</quote> for
  <olink targetptr="primary_port"/>, <quote>sec</quote> for <olink
  targetptr="secondary_port"/>, <quote>adm</quote> for <olink
  targetptr="admin_port"/> and <quote>memcached</quote> for <olink
  targetptr="memcached_port"/>.
</para>
<para>
  For example:
  <itemizedlist>
    <listitem><para>
      <command>tarantool_box: primary pri: 50000 sec: 50001 adm: 50002</command>
    </para></listitem>
    <listitem><para>
      <command>tarantool_box: primary@infobox pri: 15013 sec: 15523 adm: 10012</command>
    </para></listitem>
  </itemizedlist>
</para>
</appendix>

<!--
vim: tw=66 syntax=docbk
vim: spell spelllang=en_us
-->
