summaryrefslogtreecommitdiff
path: root/src/pmdas/logger/README
diff options
context:
space:
mode:
Diffstat (limited to 'src/pmdas/logger/README')
-rw-r--r--src/pmdas/logger/README51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/pmdas/logger/README b/src/pmdas/logger/README
new file mode 100644
index 0000000..a19eeaf
--- /dev/null
+++ b/src/pmdas/logger/README
@@ -0,0 +1,51 @@
+Logger PMDA
+===========
+
+This PMDA exports information about the event status of log files
+specified in a config file. The default configuration file is
+$PCP_VAR_DIR/config/logger/logger.conf, which should contain one
+line for each file you wish to monitor.
+
+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 logger
+
+Installation
+============
+
+ + # cd $PCP_PMDAS_DIR/logger
+
+ + 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/logger
+ # ./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/logger.log) should be checked for any warnings
+ or errors.