1PMDAORACLE(1)               General Commands Manual              PMDAORACLE(1)
2
3
4

NAME

6       pmdaoracle - Oracle database PMDA
7

DESCRIPTION

9       pmdaoracle  is  a Performance Co-Pilot PMDA which extracts live perfor‐
10       mance data from a running Oracle database.
11

INSTALLATION

13       pmdaoracle uses a configuration file from (in this order):
14       •   /etc/pcpdbi.conf
15       •   $PCP_PMDAS_DIR/oracle/oracle.conf
16       •   ./oracle.conf
17
18       This file can contain overridden values (Perl code)  for  the  settings
19       listed at the start of pmdaoracle.pl, for example:
20       •   $username - username to connect to the database [default: 'SYSTEM']
21       •   $password  -  password  to  connect to the database [default: 'man‐
22           ager']
23       •   $host - host the database is running on [default: 'localhost']
24       •   $port - port the database is listening on [default: '1521']
25       •   $os_user - operating system username (PMDA will run with the corre‐
26           sponding user id) [default: oracle]
27       •   @sids  -  an  array  of  $ORACLE_SID database identifiers [default:
28           ('master')]
29
30       In order to test your local settings, a simple script is provided  that
31       will  connect  and disconnect from the database - verifying fundamental
32       configuration is in  place  before  continuing  on.   If  the  $PCP_PM‐
33       DAS_DIR/oracle/connect.pl  script  cannot  connect, do not proceed with
34       installation of the PMDA as it will be unsuccessful.  Correct your  lo‐
35       cal settings first.
36
37       Once  this is setup, you can access the names and values for the oracle
38       performance metrics by doing the following as root:
39
40           # cd $PCP_PMDAS_DIR/oracle
41           # ./Install
42
43       To uninstall, the following must be done as root:
44
45           # cd $PCP_PMDAS_DIR/oracle
46           # ./Remove
47
48       pmdaoracle is launched by pmcd(1) and  should  never  be  executed  di‐
49       rectly. The Install and Remove scripts notify pmcd(1) when the agent is
50       installed or removed.
51

CONNECTION STATE

53       By default, pmdaoracle will aggressively attempt to maintain persistent
54       connections  to  Oracle  to ensure timely responses to its queries, and
55       will automatically re-connect if a connection drops.
56
57       However, in certain circumstances this may be undesirable, so a  manual
58       pmStore(3)  mechanism  is  provided to explicitly control disconnecting
59       and reconnecting to an Oracle instance.  This can be used, for example,
60       to  ensure  that  pmdaoracle  is not connected at shutdown, to ensure a
61       clean Oracle shutdown process.
62
63       The pmstore (1) command can be used to disconnect and reconnect.  Using
64       the  individual  instances  of the oracle.control.connected metric, one
65       can set the connection state to either up (1) or down  (0).   Addition‐
66       ally, pminfo(1) can report on the current status of Oracle connections.
67
68            # pminfo ‐f oracle.control.connected
69
70            oracle.control.connected
71                inst [0 or "master"] value 1
72
73            # pmstore oracle.control.connected 0
74            oracle.control.connected inst [0 or "master"] old value=1 new value=0
75

FILES

77       /etc/pcpdbi.conf
78           configuration file for all PCP database monitors
79       $PCP_PMDAS_DIR/oracle/oracle.conf
80           configuration file for pmdaoracle
81       $PCP_PMDAS_DIR/oracle/sample.conf
82           example configuration file for pmdaoracle using $LD_LIBRARY_PATH
83       $PCP_PMDAS_DIR/oracle/connect.pl
84           configuration test script for Oracle database connectivity
85       $PCP_PMDAS_DIR/oracle/Install
86           installation script for the pmdaoracle agent
87       $PCP_PMDAS_DIR/oracle/Remove
88           undo installation script for the pmdaoracle agent
89       $PCP_LOG_DIR/pmcd/oracle.log
90           default log file for error messages from pmdaoracle
91

PCP ENVIRONMENT

93       Environment variables with the prefix PCP_ are used to parameterize the
94       file and directory names used by PCP. On each  installation,  the  file
95       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
96       $PCP_CONF variable may be used to specify an alternative  configuration
97       file, as described in pcp.conf(5).
98

SEE ALSO

100       PCPIntro(1),  pmdadbping(1),  pminfo(1),  pmstore(1),  DBI(3)  and  pm‐
101       Store(3).
102
103
104
105Performance Co-Pilot                  PCP                        PMDAORACLE(1)
Impressum