/usr/share/doc/corosync/html/cmap

<!-- Creator     : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:32 2014 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title>CMAP_KEYS</title>

</head>
<body>

<h1 align="center">CMAP_KEYS</h1>

<a href="#NAME">NAME</a><br>
<a href="#OVERVIEW">OVERVIEW</a><br>
<a href="#KEYS">KEYS</a><br>
<a href="#DYNAMIC CHANGE USER/GROUP PERMISSION TO USE COROSYNC IPC">DYNAMIC CHANGE USER/GROUP PERMISSION TO USE COROSYNC IPC</a><br>
<a href="#DYNAMIC ADD/REMOVE OF UDPU NODE">DYNAMIC ADD/REMOVE OF UDPU NODE</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>


<h2>NAME
<a name="NAME"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">cmap_keys
&minus; Overview of keys stored in the Configuration Map</p>

<h2>OVERVIEW
<a name="OVERVIEW"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">There are
roughly 3 types of keys stored in CMAP:</p>

<p style="margin-left:11%; margin-top: 1em">* Mapping of
values stored in config file.</p>

<p style="margin-left:11%; margin-top: 1em">* Runtime
statistics.</p>

<p style="margin-left:11%; margin-top: 1em">* Other user
created values.</p>

<p style="margin-left:11%; margin-top: 1em">In this man
page, wild-cards are used with usual meaning.</p>

<h2>KEYS
<a name="KEYS"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em">internal_configuration.*</p>

<p style="margin-left:22%;">Internal configuration data.
This keys (whole prefix) is read only. It&rsquo;s only
useful for getting list of loaded services.</p>

<p style="margin-left:11%;">logging.*</p>

<p style="margin-left:22%;">Values read from configuration
file. It&rsquo;s possible to change them at runtime. If
subsystem specific configuration is needed, key must be in
form logging.logger_subsys.SERVICE.key, where SERVICE is
upper case name of service and key is same as in
configuration file. All values are of string type.</p>

<p style="margin-left:11%;">nodelist.*</p>

<p style="margin-left:22%;">Values read from configuration
file. Each node element in configuration file gets assigned
it&rsquo;s position starting from zero. So first node from
config file has nodelist.node.0. prefix. To be valid entry,
each node must have <b>ring0_addr</b> key. For change of
<b>nodeid</b> key, use u32 data type.</p>

<p style="margin-left:22%; margin-top: 1em">Local node
position is stored in <b>local_node_pos</b> key (RO), so
it&rsquo;s easy to find out nodeid/ring addresses of local
node directly from cmap.</p>

<p style="margin-left:11%;">runtime.blackbox.*</p>

<p style="margin-left:22%;">Trigger keys for store fplay
data. It&rsquo;s recommended to use corosync-blackbox
command to change keys in this prefix.</p>

<p style="margin-left:11%;">runtime.connections.*</p>

<p style="margin-left:22%;">There are informations about
total number of active connections in given moment in
<b>active</b> key, number of closed connections during whole
runtime of corosync in <b>closed</b> key and informations
about each active IPC connection. All keys in this prefix
are read-only.</p>

<p style="margin-left:11%;">runtime.connections.ID.*</p>

<p style="margin-left:22%;">Each IPC connection has unique
ID. This is in form [[short_name:][PID:]internal_id. On some
platforms, short_name and PID are not filled and only
internal_id is used.</p>

<p style="margin-left:22%; margin-top: 1em">Typical keys in
prefix are:</p>


<p style="margin-left:22%; margin-top: 1em"><b>client_pid</b>
containing PID of IPC connection (unavailable on some
platforms).</p>


<p style="margin-left:22%; margin-top: 1em"><b>dispatched</b>
with number of dispatched messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>invalid_request</b>
is number of requests made by IPC which are invalid (calling
non-existing call, ...).</p>

<p style="margin-left:22%; margin-top: 1em"><b>name</b>
containing short name of IPC connection (unavailable on some
platforms).</p>


<p style="margin-left:22%; margin-top: 1em"><b>overload</b>
is number of requests which were not processed because of
overload.</p>


<p style="margin-left:22%; margin-top: 1em"><b>queue_size</b>
contains number of messages in queue waiting for send.</p>


<p style="margin-left:22%; margin-top: 1em"><b>recv_retries</b>
is total number of interrupted receives.</p>


<p style="margin-left:22%; margin-top: 1em"><b>requests</b>
contains number of requests made by IPC.</p>


<p style="margin-left:22%; margin-top: 1em"><b>responses</b>
is number of responses sent to IPC client.</p>


<p style="margin-left:22%; margin-top: 1em"><b>send_retries</b>
contains total number of interrupted sends.</p>


<p style="margin-left:22%; margin-top: 1em"><b>service_id</b>
contains ID of service which IPC is connected to.</p>

<p style="margin-left:11%;">runtime.services.*</p>

<p style="margin-left:22%;">Prefix with statistics for
service engines. Each service has it&rsquo;s own
<b>service_id</b> key in prefix with name
runtime.services.SERVICE., where SERVICE is lower case name
of service. Inside service prefix is number of received and
send messages by corosync engine in format
runtime.services.SERVICE.EXEC_CALL.rx and
runtime.services.SERVICE.EXEC_CALL.tx, where EXEC_CALL is
internal id of service call (so for example 3 in cpg service
is receive of multicast message from other nodes).</p>

<p style="margin-left:11%;">runtime.totem.pg.mrp.srp.*</p>

<p style="margin-left:22%;">Prefix with statistics about
totem. All keys there are read only. Typical key
prefixes:</p>


<p style="margin-left:22%; margin-top: 1em"><b>commit_entered</b>
Number of times processor entered COMMIT state.</p>


<p style="margin-left:22%; margin-top: 1em"><b>commit_token_lost</b>
Number of times processor lost token in COMMIT state.</p>


<p style="margin-left:22%; margin-top: 1em"><b>consensus_timeouts</b>
How many times processor timeouted making consensus about
membership.</p>


<p style="margin-left:22%; margin-top: 1em"><b>continuous_gather</b>
How many times was processor not able to reach
consensus.</p>


<p style="margin-left:22%; margin-top: 1em"><b>firewall_enabled_or_nic_failure</b>
Set to 1 when processor was not able to reach consensus for
long time. Usual reason is badly configured firewall or
connection failure.</p>


<p style="margin-left:22%; margin-top: 1em"><b>gather_entered</b>
Number of times processor entered GATHER state.</p>


<p style="margin-left:22%; margin-top: 1em"><b>gather_token_lost</b>
Number of times processor lost token in GATHER state.</p>


<p style="margin-left:22%; margin-top: 1em"><b>mcast_retx</b>
Number of retransmitted messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>mcast_rx</b>
Number of received multicast messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>mcast_tx</b>
Number of transmitted multicast messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_commit_token_rx</b>
Number of received commit tokens.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_commit_token_tx</b>
Number of transmitted commit tokens.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_join_rx</b>
Number of received join messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_join_tx</b>
Number of transmitted join messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_merge_detect_rx</b>
Number of received member merge messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>memb_merge_detect_tx</b>
Number of transmitted member merge messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>orf_token_rx</b>
Number of received orf tokens.</p>


<p style="margin-left:22%; margin-top: 1em"><b>orf_token_tx</b>
Number of transmitted orf tokens.</p>


<p style="margin-left:22%; margin-top: 1em"><b>recovery_entered</b>
Number of times processor entered recovery.</p>


<p style="margin-left:22%; margin-top: 1em"><b>recovery_token_lost</b>
Number of times token was lost in recovery state.</p>


<p style="margin-left:22%; margin-top: 1em"><b>rx_msg_dropped</b>
Number of received messages which was dropped because they
were not expected (as example multicast message in commit
state).</p>


<p style="margin-left:22%; margin-top: 1em"><b>token_hold_cancel_rx</b>
Number of received token hold cancel messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>token_hold_cancel_tx</b>
Number of transmitted token hold cancel messages.</p>


<p style="margin-left:22%; margin-top: 1em"><b>mtt_rx_token</b>
Mean transit time of token in milliseconds. In other words,
time between two consecutive token receives.</p>


<p style="margin-left:22%; margin-top: 1em"><b>avg_token_workload</b>
Average time in milliseconds of holding time of token on
current processor.</p>


<p style="margin-left:22%; margin-top: 1em"><b>avg_backlog_calc</b>
Average number of not yet sent messages of current
processor.</p>


<p style="margin-left:11%;">runtime.totem.pg.mrp.srp.members.*</p>

<p style="margin-left:22%;">Prefix containing members of
totem single ring protocol. Each member keys has format
runtime.totem.pg.mrp.srp.members.NODEID.KEY, where key is
one of:</p>

<p style="margin-left:22%; margin-top: 1em"><b>ip</b> IP
address of member. It&rsquo;s stored in format r(RING_ID)
ip(IP_ADDRESS).</p>


<p style="margin-left:22%; margin-top: 1em"><b>join_count</b>
Number of times processor joined membership with local
processor. When processor fails and rejoins again, this
value is incremented.</p>

<p style="margin-left:22%; margin-top: 1em"><b>status</b>
Status of processor. Can be one of joined and left.</p>


<p style="margin-left:22%; margin-top: 1em"><b>config_version</b>
Config version of member node.</p>

<p style="margin-left:11%;">resources.process.PID.*</p>

<p style="margin-left:22%;">Prefix created by applications
using SAM with CMAP integration. It contains following
keys:</p>


<p style="margin-left:22%; margin-top: 1em"><b>recovery</b>
Recovery policy of process. Can be one of quit or
restart.</p>


<p style="margin-left:22%; margin-top: 1em"><b>poll_period</b>
Value passed in sam_initialize as time_interval.</p>


<p style="margin-left:22%; margin-top: 1em"><b>last_updated</b>
Last time when SAM received heartbeat from client.</p>

<p style="margin-left:22%; margin-top: 1em"><b>state</b>
State of client. Can be one of failed, stopped, running and
waiting for quorum.</p>

<p style="margin-left:11%;">uidgid.*</p>

<p style="margin-left:22%;">Informations about users/groups
which are allowed to do IPC connection to corosync.</p>

<p style="margin-left:11%;">config.reload_in_progress</p>

<p style="margin-left:22%;">This value will be set to 1 (or
created) when corosync.conf reload is started, and set to 0
when the reload is completed. This allows interested
subsystems to do atomic reconfiguration rather than changing
each key. Note that individual add/change/delete
notifications will still be sent during a reload.</p>

<h2>DYNAMIC CHANGE USER/GROUP PERMISSION TO USE COROSYNC IPC
<a name="DYNAMIC CHANGE USER/GROUP PERMISSION TO USE COROSYNC IPC"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">Is very same as
in configuration file. To add UID 500 use</p>

<p style="margin-left:11%; margin-top: 1em">#
corosync-cmapctl -s uidgid.uid.500 u8 1</p>

<p style="margin-left:11%; margin-top: 1em">GID is similar,
so to add GID use</p>

<p style="margin-left:11%; margin-top: 1em">#
corosync-cmapctl -s uidgid.gid.500 u8 1</p>

<p style="margin-left:11%; margin-top: 1em">For removal of
permission, simply delete key</p>

<p style="margin-left:11%; margin-top: 1em">#
corosync-cmapctl -d uidgid.gid.500</p>

<h2>DYNAMIC ADD/REMOVE OF UDPU NODE
<a name="DYNAMIC ADD/REMOVE OF UDPU NODE"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">We will need to
add node with address 10.34.38.108 and nodeid 3. This node
is called NEW and it&rsquo;s not running corosync yet.</p>

<p style="margin-left:11%; margin-top: 1em">* Find a node
position in node list which is not used yet. It&rsquo;s
recommended to use highest_number + 1. Let&rsquo;s say
output of corosync-cmapctl looks like:</p>


<p style="margin-left:11%; margin-top: 1em">nodelist.local_node_pos
(u32) = 1 <br>
nodelist.node.0.nodeid (u32) = 1 <br>
nodelist.node.0.ring0_addr (str) = 10.34.38.106 <br>
nodelist.node.1.nodeid (u32) = 2 <br>
nodelist.node.1.ring0_addr (str) = 10.34.38.107</p>

<p style="margin-left:11%; margin-top: 1em">So next node
position will be 2.</p>

<p style="margin-left:11%; margin-top: 1em">* Add all
entries needed for node on all running nodes, as:</p>

<p style="margin-left:11%; margin-top: 1em">#
corosync-cmapctl -s nodelist.node.2.nodeid u32 3 <br>
# corosync-cmapctl -s nodelist.node.2.ring0_addr str
10.34.38.108</p>

<p style="margin-left:11%; margin-top: 1em">Always add
ring0_addr key as last. Corosync engine on all nodes should
reply with <i>notice [TOTEM ] adding new UDPU member
{10.34.38.108}</i> message.</p>

<p style="margin-left:11%; margin-top: 1em">* Add node
information to configuration file on all nodes so it will
survive restart of corosync.</p>

<p style="margin-left:11%; margin-top: 1em">* Copy and edit
configuration file to NEW node.</p>

<p style="margin-left:11%; margin-top: 1em">* Start
corosync on NEW node.</p>

<p style="margin-left:11%; margin-top: 1em">Removal of UDPU
node is very similar slightly reversed action, so</p>

<p style="margin-left:11%; margin-top: 1em">* Stop corosync
old OLD node.</p>

<p style="margin-left:11%; margin-top: 1em">* Remove
relevant entries from cmap on all nodes.</p>

<p style="margin-left:11%; margin-top: 1em">* Change
configuration file on all nodes.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>corosync_overview</b>(8),
<b>corosync.conf</b>(5), <b>corosync-cmapctl</b>(8)</p>
<hr>
</body>
</html>
libcmap-dev 2.3.3-1ubuntu1 / usr / share / doc / corosync / html / cmap_keys.8.html
