CONFDB_KEYS(8)             Corosync Cluster Engine Programmer's Manual             CONFDB_KEYS(8)



NAME
       confdb_keys - Overview of keys stored in the Configuration Database


OVERVIEW
       There are roughly 3 types of keys stored in ConfDB:

       * Values stored in config file.

       * Runtime statistics.

       * Other user created values.


OBJECTS AND KEYS
       internal_configuration.*
              Internal configuration data. It's only useful for getting list of loaded services.


       logging.*
              Values  read  from configuration file. It's possible to change them at runtime.  If
              subsystem specific configuration is needed, each subsys must have one  object  with
              subsys key. Other keys are same as in config file.



       runtime.blackbox.*
              Trigger  keys  for store fplay data. It's recommended to use corosync-blackbox com‐
              mand to change keys in this object.


       runtime.connections.*
              There are informations about total number of active connections in given moment  in
              active key, number of closed connections during whole runtime of corosync in closed
              key and informations about each active IPC connection.


       runtime.connections.ID.*
              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.

              Typical keys in object are:

              client_pid containing PID of IPC connection (unavailable on some platforms).

              dispatched with number of dispatched messages.

              invalid_request  is  number of requests made by IPC which are invalid (calling non-
              existing call, ...).

              name containing short name of IPC connection (unavailable on some platforms).

              overload is number of requests which were not processed because of overload.

              queue_size contains number of messages in queue waiting for send.

              recv_retries is total number of interrupted receives.

              requests contains number of requests made by IPC.

              responses is number of responses sent to IPC client.

              send_retries contains total number of interrupted sends.

              service_id contains ID of service which IPC is connected to.


       runtime.services.*
              Objects with statistics for service engines. Each service has  it's  own  subobject
              with  name  SERVICE,  where SERVICE is lower case name of service. Inside object is
              number of received and send messages by  corosync  engine  in  format  runtime.ser‐
              vices.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).


       runtime.totem.pg.mrp.srp.*
              Object with statistics about totem.  Typical keys:

              commit_entered Number of times processor entered COMMIT state.

              commit_token_lost Number of times processor lost token in COMMIT state.

              consensus_timeouts  How  many times processor timeouted making consensus about mem‐
              bership.

              continuous_gather How many times was processor not able to reach consensus.

              firewall_enabled_or_nic_failure Set to 1 when processor was not able to reach  con‐
              sensus for long time. Usual reason is badly configured firewall or connection fail‐
              ure.

              gather_entered Number of times processor entered GATHER state.

              gather_token_lost Number of times processor lost token in GATHER state.

              mcast_retx Number of retransmitted messages.

              mcast_rx Number of received multicast messages.

              mcast_tx Number of transmitted multicast messages.

              memb_commit_token_rx Number of received commit tokens.

              memb_commit_token_tx Number of transmitted commit tokens.

              memb_join_rx Number of received join messages.

              memb_join_tx Number of transmitted join messages.

              memb_merge_detect_rx Number of received member merge messages.

              memb_merge_detect_tx Number of transmitted member merge messages.

              orf_token_rx Number of received orf tokens.

              orf_token_tx Number of transmitted orf tokens.

              recovery_entered Number of times processor entered recovery.

              recovery_token_lost Number of times token was lost in recovery state.

              rx_msg_dropped Number of received messages which was dropped because they were  not
              expected (as example multicast message in commit state).

              token_hold_cancel_rx Number of received token hold cancel messages.

              token_hold_cancel_tx Number of transmitted token hold cancel messages.

              mtt_rx_token  Mean  transit  time  of  token  in milliseconds. In other words, time
              between two consecutive token receives.

              avg_token_workload Average time in milliseconds of holding time of token on current
              processor.

              avg_backlog_calc Average number of not yet sent messages of current processor.


       runtime.totem.pg.mrp.srp.members.*
              Object containing members of totem single ring protocol. Each member key has format
              runtime.totem.pg.mrp.srp.members.NODEID.KEY, where key is one of:

              ip IP address of member. It's stored in format r(RING_ID) ip(IP_ADDRESS).

              join_count Number of times processor joined membership with local  processor.  When
              processor fails and rejoins again, this value is incremented.

              status Status of processor. Can be one of joined and left.


       resources.process.PID.*
              Object created by applications using SAM with ConfDB integration.  It contains fol‐
              lowing keys:

              recovery Recovery policy of process. Can be one of quit or restart.

              poll_period Value passed in sam_initialize as time_interval.

              last_updated Last time when SAM received heartbeat from client.

              state State of client. Can be one of failed, stopped, running and waiting for  quo‐
              rum.


       uidgid.*
              Informations about users/groups which are allowed to do IPC connection to corosync.
              Objects can contain uid and gid keys,  with  user  and  group  allowed  to  connect
              corosync IPC.


SEE ALSO
       corosync_overview(8), corosync.conf(5), corosync-objctl(8)



corosync Man Page                           04/05/2012                             CONFDB_KEYS(8)