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 two supported modes
46       of authentication with SQL Server.
47
48       The default is to use SQL Server authentication, which requires a user‐
49       name  and  password to be provided.  These are the following configura‐
50       tion settings (their default values are shown in parenthesis):
51
52       username (sa)  Username to connect to the database.
53
54       password (unset)
55                      Password to connect to the database.
56
57       The second option is Windows authentication mode, where logins are cre‐
58       ated  in  SQL  Server  that  are  not  based  on  operating system user
59       accounts.
60
61       trusted (false)
62                      Set to true to use Windows authentication when  connect‐
63                      ing to the database.
64
65       This  is  a Kerberos-style connection and credentials must be available
66       before the PMDA is started (see kinit(1) for further details).
67

INSTALLATION

69       To install, the following must be done as root:
70
71           # cd $PCP_PMDAS_DIR/mssql
72           # ./Install
73
74       To uninstall, the following must be done as root:
75
76           # cd $PCP_PMDAS_DIR/mssql
77           # ./Remove
78
79       pmdamssql is launched by pmcd(1) and should never be executed directly.
80       The  Install  and  Remove  scripts  notify  pmcd(1)  when  the agent is
81       installed or removed.
82
83       pmdamssql will automatically attempt to reconnect to the SQL Server  if
84       its connection is lost - e.g. if the SQL Server service is restarted.
85

FILES

87       $PCP_PMDAS_DIR/mssql/mssql.conf
88            configuration file for the pmdamssql agent
89
90       $PCP_PMDAS_DIR/mssql/Install
91            installation script for the pmdamssql agent
92
93       $PCP_PMDAS_DIR/mssql/Remove
94            undo installation script for the pmdamssql agent
95
96       $PCP_LOG_DIR/pmcd/mssql.log
97            default log file for messages from the pmdamssql agent
98
99       Note    that    the   usual/default   value   for   $PCP_PMDAS_DIR   is
100       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
101       these settings are platform dependent.
102

PCP ENVIRONMENT

104       Environment variables with the prefix PCP_ are used to parameterize the
105       file and directory names used by PCP.  On each installation,  the  file
106       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
107       $PCP_CONF variable may be used to specify an alternative  configuration
108       file, as described in pcp.conf(5).
109

SEE ALSO

111       PCPIntro(1), kinit(1) and pmcd(1).
112
113
114
115Performance Co-Pilot                  PCP                         PMDAMSSQL(1)
Impressum