summaryrefslogtreecommitdiff
path: root/src/pmdas/bash/README
diff options
context:
space:
mode:
authorIgor Pashev <pashev.igor@gmail.com>2014-10-26 12:33:50 +0400
committerIgor Pashev <pashev.igor@gmail.com>2014-10-26 12:33:50 +0400
commit47e6e7c84f008a53061e661f31ae96629bc694ef (patch)
tree648a07f3b5b9d67ce19b0fd72e8caa1175c98f1a /src/pmdas/bash/README
downloadpcp-debian.tar.gz
Debian 3.9.10debian/3.9.10debian
Diffstat (limited to 'src/pmdas/bash/README')
-rw-r--r--src/pmdas/bash/README50
1 files changed, 50 insertions, 0 deletions
diff --git a/src/pmdas/bash/README b/src/pmdas/bash/README
new file mode 100644
index 0000000..58ca47f
--- /dev/null
+++ b/src/pmdas/bash/README
@@ -0,0 +1,50 @@
+Bash PMDA
+=========
+
+This PMDA exports information from bash (GNU Bourne-Again SHell)
+processes which are setup to send trace information to PCP. This
+requires functionality present in bash version four or later.
+
+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 bash
+
+Installation
+============
+
+ + # cd $PCP_PMDAS_DIR/bash
+
+ + 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 -- everything else is automated.
+
+De-installation
+===============
+
+ + Simply use
+
+ # cd $PCP_PMDAS_DIR/bash
+ # ./Remove
+
+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/bash.log) should be checked for any warnings
+ or errors.