NAME

       pmdamssql - Microsoft SQL Server database PMDA

DESCRIPTION

       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.

CONFIGURATION

       Firstly, pmdamssql requires installation of these support packages:

       mssql-server
            The primary Microsoft SQL Server database package.

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

       pyodbc
            General Python ODBC module with Microsoft SQL Server support enabled.

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

              $PCP_PMDAS_DIR/mssql/mssql.conf

       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

       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 restarted.

FILES

       $PCP_PMDAS_DIR/mssql/mssql.conf
            configuration file for the pmdamssql agent

       $PCP_PMDAS_DIR/mssql/Install
            installation script for the pmdamssql agent

       $PCP_PMDAS_DIR/mssql/Remove
            undo installation script for the pmdamssql agent

       $PCP_LOG_DIR/pmcd/mssql.log
            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.

PCP ENVIRONMENT

       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

       PCPIntro(1) and pmcd(1).