Merge lp:~hrvojem/percona-xtradb-cluster/wsrep-status-index into lp:~percona-dev/percona-xtradb-cluster/5.5.28

[Hrvoje Matijakovic]

[Vadim Tkachenko (vadim-tk)]

review: Approve

=== modified file 'doc-pxc/source/glossary.rst'
--- doc-pxc/source/glossary.rst	2012-06-27 10:05:05 +0000
+++ doc-pxc/source/glossary.rst	2013-01-28 09:07:40 +0000
@@ -22,6 +22,9 @@
    SST
      State Snapshot Transfer is the full copy of data from one node to another. It's used when a new node joins the cluster, it has to transfer data from existing node. There are three methods of SST available in Percona XtraDB Cluster: :program:`mysqldump`, :program:`rsync` and :program:`xtrabackup` (Percona |XtraBackup| with support of XtraDB Cluster will be released soon, currently you need to use our `source code repository <http://www.percona.com/doc/percona-xtrabackup/installation/compiling_xtrabackup.html>`_). The downside of `mysqldump` and `rsync` is that your cluster becomes *READ-ONLY* while data is being copied from one node to another (SST applies :command:`FLUSH TABLES WITH READ LOCK` command). Xtrabackup SST does not require :command:`READ LOCK` for the entire syncing process, only for syncing |.FRM| files (the same as with regular backup).
 
+   UUID 
+      universally unique identifier which uniquely identifies the state and the sequence of changes node undergoes.
+
    XtraBackup
      *Percona XtraBackup* is an open-source hot backup utility for |MySQL| - based servers that doesn’t lock your database during the backup.
 
@@ -37,15 +40,33 @@
    my.cnf
      This file refers to the database server's main configuration file. Most Linux distributions place it as :file:`/etc/mysql/my.cnf`, but the location and name depends on the particular installation. Note that this is not the only way of configuring the server, some systems does not have one even and rely on the command options to start the server and its defaults values.
 
+   cluster replication
+     Normal replication path for cluster members. Can be encrypted (not by default) and unicast or multicast (unicast by default). Runs on tcp port 4567 by default.
+
    datadir
     The directory in which the database server stores its databases. Most Linux distribution use :file:`/var/lib/mysql` by default.
 
+   donor node
+    The node elected to provide a state transfer (SST or IST).
+
    ibdata
      Default prefix for tablespace files, e.g. :file:`ibdata1` is a 10MB  autoextendable file that |MySQL| creates for the shared tablespace by default. 
 
    innodb_file_per_table
      InnoDB option to use separate .ibd files for each table.
 
+   joiner node
+     The node joining the cluster, usually a state transfer target.
+    
+   node
+     A cluster node -- a single mysql instance that is in the cluster.
+     
+   primary cluster
+     A cluster with :term:`quorum`. A non-primary cluster will not allow any operations and will give ``Unknown command`` errors on any clients attempting to read or write from the database.
+
+   quorum 
+     A majority (> 50%) of nodes. In the event of a network partition, only the cluster partition that retains a quorum (if any) will remain Primary by default.
+
    split brain
      Split brain occurs when two parts of a computer cluster are disconnected, each part believing that the other is no longer running. This problem can lead to data inconsistency.
 
@@ -65,10 +86,10 @@
      Each table using the :program:`MERGE` storage engine, besides of a :term:`.frm` file, will have :term:`.MRG` file containing the names of the |MyISAM| tables associated with it.
 
    .TRG
-     File containing the triggers associated to a table, e.g. `:file:`mytable.TRG`. With the :term:`.TRN` file, they represent all the trigger definitions.
+     File containing the triggers associated to a table, e.g. :file:`mytable.TRG`. With the :term:`.TRN` file, they represent all the trigger definitions.
 
    .TRN
-     File containing the triggers' Names associated to a table, e.g. `:file:`mytable.TRN`. With the :term:`.TRG` file, they represent all the trigger definitions.
+     File containing the triggers' Names associated to a table, e.g. :file:`mytable.TRN`. With the :term:`.TRG` file, they represent all the trigger definitions.
 
    .ARM
      Each table with the :program:`Archive Storage Engine` has ``.ARM`` file which contains the metadata of it.

=== modified file 'doc-pxc/source/index.rst'
--- doc-pxc/source/index.rst	2012-06-27 10:05:05 +0000
+++ doc-pxc/source/index.rst	2013-01-28 09:07:40 +0000
@@ -106,6 +106,7 @@
    :glob:
 
    release-notes/release-notes_index
+   wsrep-status-index
    bugreport
    glossary
 

=== added file 'doc-pxc/source/wsrep-status-index.rst'
--- doc-pxc/source/wsrep-status-index.rst	1970-01-01 00:00:00 +0000
+++ doc-pxc/source/wsrep-status-index.rst	2013-01-28 09:07:40 +0000
@@ -0,0 +1,170 @@
+.. _wsrep_status_index:
+
+=================================
+ Index of wsrep status variables
+=================================
+
+.. variable:: wsrep_local_state_uuid
+  
+This variable contains :term:`UUID` state stored on the node.
+
+.. variable:: wsrep_protocol_version
+  
+Version of the wsrep protocol used. 
+
+.. variable:: wsrep_last_committed
+  
+Sequence number of the last committed transaction. 
+
+.. variable:: wsrep_replicated
+  
+Total number of writesets sent to other nodes.
+
+.. variable:: wsrep_replicated_bytes
+  
+Total size (in bytes) of writesets sent to other nodes.
+
+.. variable:: wsrep_received
+  
+Total number of writesets received from other nodes. 
+
+.. variable:: wsrep_received_bytes
+  
+Total size (in bytes) of writesets received from other nodes.
+
+.. variable:: wsrep_local_commits
+  
+Number of writesets commited on the node.
+
+.. variable:: wsrep_local_cert_failures
+  
+Number of writesets that failed the certification test.
+
+.. variable:: wsrep_local_bf_aborts
+  
+Number of local transactions that were aborted by slave transactions while being executed.
+
+.. variable:: wsrep_local_replays
+  
+Number of transaction replays due to "asymmetric lock granularity".
+
+.. variable:: wsrep_local_send_queue
+  
+Current length of the send queue. Show the number of writesets waiting to be sent. 
+
+.. variable:: wsrep_local_send_queue_avg
+  
+Average length of the send queue since the last status query. When cluster experiences network throughput issues or replication throttling this value will be significantly bigger than ``0``.
+
+.. variable:: wsrep_local_recv_queue
+  
+Current length of the receive queue. Show the number of writesets waiting to be applied. 
+
+.. variable:: wsrep_local_recv_queue_avg
+  
+Average length of the receive queue since the last status query. When this number is bigger than ``0`` this means node can't apply writesets as fast as they're received. This could be sign that node is overloaded and it will cause the replication throttling. 
+
+.. variable:: wsrep_flow_control_paused
+  
+Time since the last status query that replication was paused due to flow control.
+
+.. variable:: wsrep_flow_control_sent
+  
+Number of ``FC_PAUSE`` events sent since the last status query.
+
+.. variable:: wsrep_flow_control_recv
+  
+Number of ``FC_PAUSE`` events sent and received since the last status query.
+
+.. variable:: wsrep_cert_deps_distance
+  
+Average distance between highest and lowest sequence numbet that can be possibly applied in parallel.
+
+.. variable:: wsrep_apply_oooe
+  
+This variable shows parallelization efficiency, how often writests have been applied out-of-order. 
+
+.. variable:: wsrep_apply_oool
+
+This variable shows how often was writeset with higher sequence number applied before the one with lower sequence number.
+  
+.. variable:: wsrep_apply_window
+  
+Average distance between highest and lowest concurrently applied sequence number.
+
+.. variable:: wsrep_commit_oooe
+  
+This variable shows how often a transaction has been applied out of order.
+
+.. variable:: wsrep_commit_oool
+  
+This variable currently isn't being used.
+
+.. variable:: wsrep_commit_window
+  
+Average distance between highest and lowest concurrently committed sequence number.
+
+.. variable:: wsrep_local_state
+  
+This variable shows internal Galera state number. Possible values are:
+ * 1 - Joining (requesting/receiving State Transfer) - node is joining the cluster
+ * 2 - Donor/Desynced - node is the donor to the node joining the cluster
+ * 3 - Joined - node has joined the cluster
+ * 4 - Synced - node is synced with the cluster
+
+.. variable:: wsrep_local_state_comment
+  
+Description of the :variable:`wsrep_local_state` variable.
+
+.. variable:: wsrep_cert_index_size
+  
+.. variable:: wsrep_causal_reads
+
+Shows the number of writesets processed while the variable :variable:`wsrep_causal_reads` was set to ``ON``.
+
+.. variable:: wsrep_incoming_addresses
+
+Shows the comma-separated list of incoming node addresses in the cluster.
+  
+.. variable:: wsrep_cluster_conf_id
+
+Number of cluster membership changes happened.
+  
+.. variable:: wsrep_cluster_size
+  
+Current number of nodes in the cluster. 
+
+.. variable:: wsrep_cluster_state_uuid
+  
+This variable contains :term:`UUID` state of the cluster. When this value is the same as the one in :variable:`wsrep_local_state_uuid` node is synced with the cluster.
+
+.. variable:: wsrep_cluster_status
+
+Status of the cluster component. Possible values are:
+  * ``Primary`` -
+  * ``Non-Primary`` -
+  * ``Disconnected`` -
+  
+.. variable:: wsrep_connected
+  
+.. variable:: wsrep_local_index
+  
+Node index in the cluster 
+
+.. variable:: wsrep_provider_name
+  
+Name of the wsrep provider (usually ``Galera``).
+
+.. variable:: wsrep_provider_vendor
+  
+Name of the wsrep provider vendor (usually ``Codership Oy``)
+
+.. variable:: wsrep_provider_version
+  
+Current version of the wsrep provider.
+
+.. variable:: wsrep_ready
+  
+This variable shows if node is ready to accept queries. If status is ``OFF`` almost all the queries will fail with ``ERROR 1047 (08S01) Unknown Command`` error (unless :variable:`wsrep_on` variable is set to ``0``)
+
+