pmdamssql(1) — Linux manual page


PMDAMSSQL(1)               General Commands Manual              PMDAMSSQL(1)

NAME         top

       pmdamssql - Microsoft SQL Server database PMDA

DESCRIPTION         top

       pmdamssql is a Performance Co-Pilot (PCP) Performance Metrics Domain
       Agent (PMDA) which extracts live performance data from a running
       Microsoft SQL Server database server.


       Firstly, pmdamssql requires installation of these support packages:

            The primary Microsoft SQL Server database package.

       msodbcsql17 or (msodbcsql)
            Latest Microsoft SQL Server ODBC bindings.

            General Python ODBC module with Microsoft SQL Server support

       Next, pmdamssql reads an optional ini-style configuration file:


       This file currently allows for two sections, one for configuring the
       library that connects to SQL server, the other for authenticating
       with SQL server.

       [connection] section specifies values for the following settings
       (their default values are shown in parenthesis):

       driver ({ODBC Driver 17 for SQL Server})
                      ODBC driver string.

       server (tcp:localhost)
                      SQL Server socket connection string.

       timeout (2)    Connection timeout setting, in seconds.

       [authentication] section specifies values for the following settings
       (their default values are shown in parenthesis):

       username (sa)  Username to connect to the database.

       password (unset)
                      Password to connect to the database.

INSTALLATION         top

       To install, the following must be done as root:

           # cd $PCP_PMDAS_DIR/mssql
           # ./Install

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/mssql
           # ./Remove

       pmdamssql is launched by pmcd(1) and should never be executed
       directly.  The Install and Remove scripts notify pmcd(1) when the
       agent is installed or removed.

       pmdamssql will automatically attempt to reconnect to the SQL Server
       if its connection is lost - e.g. if the SQL Server service is

FILES         top

            configuration file for the pmdamssql agent

            installation script for the pmdamssql agent

            undo installation script for the pmdamssql agent

            default log file for messages from the pmdamssql agent

       Note that the usual/default value for $PCP_PMDAS_DIR is
       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp
       but these settings are platform dependent.


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

SEE ALSO         top

       PCPIntro(1) and pmcd(1).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨⟩.
       If you have a bug report for this manual page, send it to  This page was obtained from the project's upstream
       Git repository ⟨⟩ on
       2020-08-13.  (At that time, the date of the most recent commit that
       was found in the repository was 2020-08-11.)  If you discover any
       rendering problems in this HTML version of the page, or you believe
       there is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Performance Co-Pilot                 PCP                        PMDAMSSQL(1)