1PMDAMSSQL(1) General Commands Manual PMDAMSSQL(1)
2
6 pmdamssql - Microsoft SQL Server database PMDA
7
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
14 Firstly, pmdamssql requires installation of these support packages:
15 mssql-server
17 The primary Microsoft SQL Server database package.
18 msodbcsql18, msodbcsql17 or msodbcsql
20 Microsoft SQL Server ODBC bindings.
21 pyodbc
23 General Python ODBC module with Microsoft SQL Server support en‐
24 abled.
25 Next, pmdamssql reads an optional ini-style configuration file:
27 $PCP_PMDAS_DIR/mssql/mssql.conf
29 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 [connection] section specifies values for the following settings (their
35 default values are shown in parenthesis):
36 driver ({ODBC Driver 17 for SQL Server})
38 ODBC driver string.
39 server (tcp:localhost)
41 SQL Server socket connection string.
42 timeout (2) Connection timeout setting, in seconds.
44 [authentication] section specifies values for the two supported modes
46 of authentication with SQL Server.
47 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 username (pcp) Username to connect to the database.
53 password (empty)
55 Password to connect to the database.
56 Note that if a SQL Server Assessments API configuration file is found
58 at /var/opt/mssql/secrets/assessment, then pmdamssql reads the username
59 and password from that file preferentially. The format is simply a two
60 line text file, the first containing the username and the second the
61 password.
62 The second option is Windows authentication mode, where logins are cre‐
64 ated in SQL Server that are not based on operating system user ac‐
65 counts.
66 trusted (false)
68 Set to true to use Windows authentication when connect‐
69 ing to the database.
70 This is a Kerberos-style connection and credentials must be available
72 before the PMDA is started (see kinit(1) for further details).
73
75 To install, the following must be done as root:
76 # cd $PCP_PMDAS_DIR/mssql
78 # ./Install
79 To uninstall, the following must be done as root:
81 # cd $PCP_PMDAS_DIR/mssql
83 # ./Remove
84 pmdamssql is launched by pmcd(1) and should never be executed directly.
86 The Install and Remove scripts notify pmcd(1) when the agent is in‐
87 stalled or removed.
88 pmdamssql will automatically attempt to reconnect to the SQL Server if
90 its connection is lost - e.g. if the SQL Server service is restarted.
91
93 $PCP_PMDAS_DIR/mssql/mssql.conf
94 configuration file for the pmdamssql agent
95 $PCP_PMDAS_DIR/mssql/Install
97 installation script for the pmdamssql agent
98 $PCP_PMDAS_DIR/mssql/Remove
100 undo installation script for the pmdamssql agent
101 $PCP_LOG_DIR/pmcd/mssql.log
103 default log file for messages from the pmdamssql agent
104 Note that the usual/default value for $PCP_PMDAS_DIR is
106 /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
107 these settings are platform dependent.
108
110 Environment variables with the prefix PCP_ are used to parameterize the
111 file and directory names used by PCP. On each installation, the file
112 /etc/pcp.conf contains the local values for these variables. The
113 $PCP_CONF variable may be used to specify an alternative configuration
114 file, as described in pcp.conf(5).
115
117 PCPIntro(1), kinit(1) and pmcd(1).
118Performance Co-Pilot PCP PMDAMSSQL(1)