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

NAME

6       pmdamssql - Microsoft SQL Server database PMDA
7

DESCRIPTION

9       pmdamssql  is  a  Performance Co-Pilot (PCP) Performance Metrics Domain
10       Agent (PMDA) which extracts live performance data from a running Micro‐
11       soft SQL Server database server.
12

CONFIGURATION

14       Firstly, pmdamssql requires installation of these support packages:
15
16       mssql-server
17            The primary Microsoft SQL Server database package.
18
19       msodbcsql17 or (msodbcsql)
20            Latest Microsoft SQL Server ODBC bindings.
21
22       pyodbc
23            General  Python  ODBC  module  with  Microsoft  SQL Server support
24            enabled.
25
26       Next, pmdamssql reads an optional ini-style configuration file:
27
28              $PCP_PMDAS_DIR/mssql/mssql.conf
29
30       This file currently allows for two sections, one  for  configuring  the
31       library  that connects to SQL server, the other for authenticating with
32       SQL server.
33
34       [connection] section specifies values for the following settings (their
35       default values are shown in parenthesis):
36
37       driver ({ODBC Driver 17 for SQL Server})
38                      ODBC driver string.
39
40       server (tcp:localhost)
41                      SQL Server socket connection string.
42
43       timeout (2)    Connection timeout setting, in seconds.
44
45       [authentication]  section  specifies  values for the following settings
46       (their default values are shown in parenthesis):
47
48       username (sa)  Username to connect to the database.
49
50       password (unset)
51                      Password to connect to the database.
52

INSTALLATION

54       To install, the following must be done as root:
55
56           # cd $PCP_PMDAS_DIR/mssql
57           # ./Install
58
59       To uninstall, the following must be done as root:
60
61           # cd $PCP_PMDAS_DIR/mssql
62           # ./Remove
63
64       pmdamssql is launched by pmcd(1) and should never be executed directly.
65       The  Install  and  Remove  scripts  notify  pmcd(1)  when  the agent is
66       installed or removed.
67
68       pmdamssql will automatically attempt to reconnect to the SQL Server  if
69       its connection is lost - e.g. if the SQL Server service is restarted.
70

FILES

72       $PCP_PMDAS_DIR/mssql/mssql.conf
73            configuration file for the pmdamssql agent
74
75       $PCP_PMDAS_DIR/mssql/Install
76            installation script for the pmdamssql agent
77
78       $PCP_PMDAS_DIR/mssql/Remove
79            undo installation script for the pmdamssql agent
80
81       $PCP_LOG_DIR/pmcd/mssql.log
82            default log file for messages from the pmdamssql agent
83
84       Note    that    the   usual/default   value   for   $PCP_PMDAS_DIR   is
85       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
86       these settings are platform dependent.
87

PCP ENVIRONMENT

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

SEE ALSO

96       PCPIntro(1) and pmcd(1).
97
98
99
100Performance Co-Pilot                  PCP                         PMDAMSSQL(1)
Impressum