pcp/README

   1 NOTE! The samba.c source in this directory has been removed pending
   2 approval from SGI to use it under the GPLv3 license.
   3
   4 Please see Samba 3.0.xx for a copy of this code under the GPLv2
   5 license if required.
   6
   7 samba PMDA
   8 ===========
   9
  10 This PMDA is a sample that illustrates how a simple samba monitor
  11 PMDA might be constructed, using a shared memory segment to transfer
  12 information about transaction activity from the smb daemon.
  13
  14 Note:
  15         This PMDA may be remade from source and hence requires
  16         a C compiler and Perl to be installed.
  17
  18         Uses of make(1) may fail (without removing or clobbering files)
  19         if the C compiler cannot be found.  This is most likely to
  20         happen when running the PMDA ./Install script.
  21
  22         The only remedial action is to install the C compiler, or
  23         hand-craft changes to the Makefile.
  24
  25 Metrics
  26 =======
  27
  28 The file ./help contains descriptions for all of the metrics exported
  29 by this PMDA.
  30
  31 Once the PMDA has been installed, the following command will list all
  32 the available metrics and their explanatory "help" text:
  33
  34         $ pminfo -fT samba
  35
  36 Installation
  37 ============
  38
  39  +  # mkdir /var/pcp/pmdas/samba
  40  +  # cp * /var/pcp/pmdas/samba
  41  +  # cp ../source/include/profile.h /var/pcp/pmdas/samba
  42  +  # cd /var/pcp/pmdas/samba
  43
  44  +  Check that there is no clash in the Performance Metrics Domain
  45     defined in ./domain.h and the other PMDAs currently in use
  46     (/etc/pmcd.conf).  If there is, edit ./domain.h to choose another
  47     domain number.
  48
  49  +  If you are not installing on an IRIX system, edit samba.c and
  50     comment out the
  51
  52         #define IRIX 1
  53
  54  +  Then simply use
  55
  56         # ./Install
  57
  58  +  Alternatively, to install just the Performance Metrics Name Space
  59     for the samba metrics on the local system, but not the samba PMDA
  60     (presumably because the local system is running PCP 1.x and you
  61     wish to connect to a remote system where PCP 2.0 and the samba PMDA
  62     is running), make sure the Performance Metrics Domain defined in
  63     ./domain.h matches the domain chosen for the samba PMDA on the
  64     remote system (check the second field in the corresponding line of
  65     the pmcd.conf file on the remote system - located in /etc on IRIX
  66     and /var/pcp/config/pmcd on Linux), then
  67
  68         # ./Install -N
  69
  70 De-installation
  71 ===============
  72
  73  +  Simply use
  74
  75         # cd /var/pcp/pmdas/samba
  76         # ./Remove
  77
  78  +  If you also want to remove the sources use
  79
  80         # cd /
  81         # rm -rf /var/pcp/pmdas/samba
  82
  83 Making something happen
  84 =======================
  85
  86 The application "smbd" updates the shared memory segment to add
  87 profile information about smbd. By default updating is disabled.
  88 To start updating of the shared memory segment you need to run the
  89 smbcontrol command to turn on profiling for one or more smbd processes
  90 (see the man page for smbcontrol).
  91
  92
  93
  94 Troubleshooting
  95 ===============
  96
  97  +  After installing or restarting the agent, the PMCD log file
  98     (pmcd.log) and the PMDA log file (samba.log) should be checked
  99     for any warnings or errors. These logs are located in
 100     /var/log/pcp/pmcd on Linux and /var/adm/pcplog on IRIX.