A newer version of this documentation is available. Click here to view the most up-to-date release of the Greenplum 4.x documentation.


Installs the Command Center database (gpperfmon) and optionally enables the data collection agents.


      [--enable --password gpmon_password --port gpdb_port] 
      [--pgpass path_to_file] 

gpperfmon_install --help | -h | -?


The gpperfmon_install utility automates the steps required to enable the data collection agents. You must be the Greenplum Database system user (gpadmin) in order to run this utility. If using the --enable option, Greenplum Database must be restarted after the utility completes.

When run without any options, the utility will just create the gpperfmon database (the database used to store system metrics collected by the data collection agents). When run with the --enable option, the utility will also run the following additional tasks necessary to enable the data collection agents:

  1. Creates the gpmon superuser role in Greenplum Database. The data collection agents require this role to connect to the database and write their data. The gpmon superuser role uses MD5-encrypted password authentication by default. Use the --password option to set the gpmon superuser's password. Use the --port option to supply the port of the Greenplum Database master instance.
  2. Updates the $MASTER_DATA_DIRECTORY/pg_hba.conf file. The utility will add the following line to the host-based authentication file (pg_hba.conf). This allows the gpmon user to locally connect to any database using MD5-encrypted password authentication:
    local     all    gpmon    md5
    Note: If you are using Greenplum Database version 4.2.1 or higher, you have the option of using SHA-256-encrypted password authentication. You can specify SHA-256 authentication by changing thepassword_hash_algorithm server parameter. This parameter can be set either system-wide or on a session level. If you have specified SHA-256 authentication, you have to manually edit the pg_hba.conf file after running the gpperfmon_install utility and change the md5 specification to password.
  3. Updates the password file (.pgpass). In order to allow the data collection agents to connect as the gpmon role without a password prompt, you must have a password file that has an entry for the gpmon user. The utility adds the following entry to your password file (if the file does not exist, the utility will create it):
    If your password file is not located in the default location (~/.pgpass), use the --pgpass option to specify the file location.
  4. Sets the server configuration parameters for Greenplum Command Center. The following parameters must be enabled in order for the data collection agents to begin collecting data. The utility will set the following parameters in the Greenplum Database postgresql.conf configuration files:

    gp_enable_gpperfmon=on (in all postgresql.conf files) gpperfmon_port=8888 (in all postgresql.conf files) gp_external_enable_exec=on (in the master postgresql.conf file)


In addition to creating the gpperfmon database, performs the additional steps required to enable the data collection agents. When --enable is specified the utility will also create and configure the gpmon superuser account and set the Command Center server configuration parameters in the postgresql.conf files.
--password gpmon_password
Required if --enable is specified. Sets the password of the gpmon superuser.
--port gpdb_port
Required if --enable is specified. Specifies the connection port of the Greenplum Database master.
--pgpass path_to_file
Optional if --enable is specified. If the password file is not in the default location of ~/.pgpass, specifies the location of the password file.
Sets the logging level to verbose.
--help | -h | -?
Displays the online help.


Create the gpperfmon database only:

$ su - gpadmin 
$ gpperfmon_install

Create the gpperfmon database, create the gpmon superuser, and enable the data collection agents:

$ su - gpadmin
$ gpperfmon_install --enable --password p@$$word --port 5432
$ gpstop -r

See Also