1 files changed, 77 insertions, 0 deletions
diff --git a/src/pmdas/txmon/README b/src/pmdas/txmon/README
new file mode 100644
index 0000000..97fea32
--- /dev/null
+++ b/src/pmdas/txmon/README
@@ -0,0 +1,77 @@
+txmon PMDA
+===========
+
+This PMDA is a sample that illustrates how a simple transaction monitor
+PMDA might be constructed, using a shared memory segment to transfer
+information about transaction activity from the applications that
+submit (or process) transactions and the txmon PMDA.
+
+Although the metrics supported are simple, the framework is quite
+general and could be extended to implement a much more complex PMDA.
+
+Note:
+	This PMDA may be remade from source and hence requires IDO (or
+	more specifically a C compiler) to be installed.
+
+	Uses of make(1) may fail (without removing or clobbering files)
+	if the C compiler cannot be found.  This is most likely to
+	happen when running the PMDA ./Install script.
+
+	The only remedial action is to install the C compiler, or
+	hand-craft changes to the Makefile.
+
+Metrics
+=======
+
+The file ./help contains descriptions for all of the metrics exported
+by this PMDA.
+
+Once the PMDA has been installed, the following command will list all
+the available metrics and their explanatory "help" text:
+
+	$ pminfo -fT txmon
+
+Installation
+============
+
+ +  # cd $PCP_PMDAS_DIR/txmon
+
+ +  Check that there is no clash in the Performance Metrics Domain
+    defined in ./domain.h and the other PMDAs currently in use (see
+    $PCP_PMCDCONF_PATH).  If there is, edit ./domain.h to choose another
+    domain number.
+
+ +  Then simply use
+
+	# ./Install
+
+    and choose both the "collector" and "monitor" installation
+    configuration options.
+
+    You will be prompted to define the names of the transaction types
+    to be monitored -- everything else is automated.
+
+De-installation
+===============
+
+ +  Simply use
+
+        # cd $PCP_PMDAS_DIR/txmon
+	# ./Remove
+
+Making something happen
+=======================
+
+The application ./txrecord updates the shared memory segment to add
+new information about transactions and their service times.  Usually
+this would be run from the ./genload script that will continue to
+update the shared memory segment with data drawn from some synthetic
+distributions.
+
+Troubleshooting
+===============
+
+ +  After installing or restarting the agent, the PMCD log file
+    ($PCP_LOG_DIR/pmcd/pmcd.log) and the PMDA log file
+    ($PCP_LOG_DIR/pmcd/txmon.log) should be checked for any warnings
+    or errors.