Movatterモバイル変換

mamonsuagent [agent_action]

mamonsubootstrap-Mmamonsu_user [-c |--config] [-x |--create-extensions] [connection_options]

mamonsuexport {template |config}filename [export_options]

mamonsureport [report_options] [connection_options]

mamonsutune [tuning_options] [connection_options]

mamonsuupload [upload_options]

mamonsuzabbixdashboarduploadtemplate_name

mamonsuzabbix {template |host |hostgroup}server_action

mamonsuzabbixitem {error |lastvalue |lastclock}host_id

mamonsuzabbix version

mamonsu [-c |--config] [-d |--daemonize]

mamonsu--version

mamonsu--help

• A supervisor process that monitors database and system activity.

• Plugins that specify whichPostgres Pro and system metrics to collect.

• Customizable configuration and template files that define which plugins to use and how to visualize the collected data.

Important

Before you start installation, attentively readCompatibility Considerations.

Note

Whilemamonsu can collectPostgres Pro metrics from a remote cluster, system metrics are only collected locally. If you choose to collectPostgres Pro metrics remotely, make sure to disable collection of system metrics to avoid confusion, as they will be displayed under the same host inZabbix.

1. Optionally, bootstrapmamonsu

   If you omit this step, metrics can only be collected on behalf of a superuser, which is not recommended.

   In this step, thebootstrap command sets themamonsu user, createsmamonsu schema in the specified or implied database, as well as extensions and objects needed for monitoring.

   bootstrap has no mandatory options. When run without options, it takes the values needed from the configuration file (/etc/mamonsu/agent.conf by default). Below is a simple example of bootstrap:

   1. In the[postgres] section ofagent.conf, specify connection parameters for thePostgres Pro cluster you are going to monitor. For more details, seeConnection Parameters.

   2. Run the following command to bootstrapmamonsu:

      mamonsu bootstrap

      This command will create the usermamonsu with the passwordmamonsu, create monitoring functions in the database specified inagent.conf and grant the right to execute them to themamonsu user.

   In the following example,bootstrap options are passed explicitly.

   1. Create a non-privileged database user formamonsu. For example:

      CREATE USER mamonsu_user WITH PASSWORD 'mamonsu_password';GRANT pg_monitor TO mamonsu_user;

   2. Create a database that will be used for connection toPostgres Pro. For example:

      CREATE DATABASE mamonsu_database OWNER mamonsu_user;

   3. Run the following command to bootstrapmamonsu:

      mamonsu bootstrap -M mamonsu_user -x -c /etc/mamonsu/agent.conf -d mamonsu_database -U postgres --host myhost --port 5432

      For details of the options-M,-x and-c, seebootstrap. For details of other options, seeConnection Options. This command will create monitoring functions in themamonsu_database and grant the right to execute them tomamonsu_user. Thepg_buffercache extension will also be created to ensure collection of metrics on the shared buffer cache, and the path to the configuration file will be changed.

   As a result, a superuser connection is no longer required. Note thatmamonsu also creates several tables in themamonsu schema in the specified database. Do not delete these tables as they are required formamonsu to work.

2. Configuremamonsu

   Edit theagent.conf configuration file, which is located in the/etc/mamonsu/ directory by default.

   • ConfigureZabbix-related settings. Theaddress field must point to the runningZabbix server, while theclient field must provide the name of theZabbix host. You can find the list of hosts available for your account in theZabbix web interface underConfiguration >Hosts.

     [zabbix]; enabled by defaultenabled =Trueclient =zabbix_host_nameaddress =zabbix_server

   • By default,mamonsu will collect bothPostgres Pro and system metrics. If required, you can disable metrics collection of either type by setting theenabled parameter toFalse in the[postgres] or[system] section of theagent.conf file, respectively.

     [system]; enabled by defaultenabled = True

     Note

     Whilemamonsu can collectPostgres Pro metrics from a remote cluster, system metrics are only collected locally. If you choose to collectPostgres Pro metrics remotely, make sure to disable collection of system metrics to avoid confusion, as they will be displayed under the same host inZabbix.

   • If you are going to collectPostgres Pro metrics, specify connection parameters for thePostgres Pro cluster you are going to monitor. In theuser,password, anddatabase fields, you must specify themamonsu_user,mamonsu_password, and themamonsu_database used for bootstrap, respectively. If you skipped the bootstrap, specify superuser credentials and the database to connect to.

     [postgres]; enabled by defaultenabled = Trueuser =mamonsu_userdatabase =mamonsu_databasepassword =mamonsu_passwordport = 5432

   These are the mainmamonsu settings to get started. You can also fine-tune othermamonsu settings as explained inthe section called “Configuration Parameters”.

3. Configure how to display metrics on theZabbix server

   1. Generate a template that defines how to visualize the collected metrics on theZabbix server:

      mamonsu export template template.xml

      mamonsu generates thetemplate.xml file in your current directory. By default, the name of the template that will be displayed in theZabbix account isPostgresPro-OS, whereOS is the name of your operating system. To get a template with a different display name, you can run the above command with the--template-name option.

   2. Optionally, specify yourZabbix account settings in the following environment variables on your monitoring system:

      • Set theZABBIX_USER andZABBIX_PASSWD variables to the login and password of yourZabbix account, respectively.

      • Set theZABBIX_URL tohttp://zabbix/

      If you skip this step, you will have to add the following options to allmamonsu zabbix commands that you run:

      --url=http://zabbix/ --user=zabbix_login --password=zabbix_password

   3. Uploadtemplate.xml to theZabbix server.

      mamonsu zabbix template export template.xml

      Alternatively, you can upload the template through theZabbix web interface: log in to yourZabbix account and selectTemplates >Import.

   4. Link the generated template to the host to be monitored.

      In theZabbix web interface, select your host, go toTemplates >Add, select your template, and clickUpdate.

      Tip

      If you would like to link a template with a newZabbix host, you can do it from the command line usingmamonsu zabbix commands. Seethe section called “ManagingZabbix Server Settings from the Command Line” for details.

agent

Syntax:

mamonsu agent { metric-list | metric-getmetric_name | version }

Provide information on the collected metrics from the command line. You can specify one of the following parameters:

bootstrap#

Syntax:

mamonsu bootstrap -Mmamonsu_user        [-c[config_file] | --config[=config_file]]        [-x | --create-extensions] [connection_options]

Bootstrapmamonsu. This command can take the following options:

export

Syntax:

mamonsu export configfilename.conf  [--add-plugins=plugin_directory]mamonsu export templatefilename.xml [--add-plugins=plugin_directory]                                     [--template-name=template_name]                                     [--application=application_name]                                     [--old-zabbix]

Generate a template or configuration file for metrics collection. The optional parameters to customize metrics collection are as follows:

export zabbix-parameters

Syntax:

mamonsu export zabbix-parametersfilename.conf [--add-plugins=plugin_directory]                                     [--plugin-type={pg | sys | all}]                                     [--pg-version=version]                                     [--config=config_file]

Export metrics configuration for use with the nativeZabbix agent. The optional parameters to customize metrics collection are as follows:

export zabbix-template

Syntax:

mamonsu export zabbix-templatefilename.conf [--add-plugins=plugin_directory]                                     [--plugin-type={pg | sys | all}]                                     [--template-name=template_name]                                     [--application=application_name]                                     [--config=config_file]                                     [--old-zabbix]

Export a template for use with the nativeZabbix agent. The optional parameters to customize metrics collection are as follows:

report

Syntax:

mamonsu report [--run-system=Boolean] [--run-postgres=Boolean]               [--print-report=Boolean] [--report-path=report_file]               [--disable-sudo] [connection_options]

Generate a detailed report on the hardware, operating system, memory usage and other parameters of the monitored system, as well asPostgres Pro configuration.

The following optional parameters customize the report:

tune

Syntax:

mamonsu tune [--dry-run] [--disable-sudo] [--log-level {INFO|DEBUG|WARN}]             [--dont-tune-pgbadger] [--dont-reload-postgresql]             [connection_options]

OptimizePostgres Pro and system configuration based on the collected statistics. You can use the following options:

upload#

Syntax:

mamonsu upload [--zabbix-file=metrics_file]               [--zabbix-address=zabbix_address] [--zabbix-port=port_number]                [--zabbix-client=zabbix_host_name] [--zabbix-log-level={INFO|DEBUG|WARN}]

Upload metrics data previously saved into a file onto a Zabbix server for visualization. For details on how to save metrics into a file, seethe section called “Logging Parameters”.

This command can take the following options:

zabbix dashboard upload

Syntax:

mamonsu dashboard uploadtemplate_name

Upload aZabbix dashboard with themamonsu metrics to a template on theZabbix server version 6.0 or higher.

zabbix item

Syntax:

mamonsu zabbix item {error | lastvalue | lastclock }host_name

View the specified property of the latest metrics data received byZabbix for the specified host.

zabbix version

Syntax:

mamonsu zabbix version

Get the version of theZabbix server thatmamonsu is connected to.

zabbix host

Syntax:

mamonsu zabbix host listmamonsu zabbix host showhost_namemamonsu zabbix host idhost_namemamonsu zabbix host deletehost_idmamonsu zabbix host createhost_namehostgroup_idtemplate_idmamonsu_addressmamonsu zabbix host info {templates | hostgroups | graphs | items}host_id

ManageZabbix hosts using one of the actions described inthe section called “Zabbix Server Actions”.

zabbix hostgroup

Syntax:

mamonsu zabbix hostgroup listmamonsu zabbix hostgroup showhostgroup_namemamonsu zabbix hostgroup idhostgroup_namemamonsu zabbix hostgroup deletehostgroup_idmamonsu zabbix hostgroup createhostgroup_name

ManageZabbix host groups using one of the actions described inthe section called “Zabbix Server Actions”.

zabbix template

Syntax:

mamonsu zabbix template listmamonsu zabbix template showtemplate_namemamonsu zabbix template idtemplate_namemamonsu zabbix template deletetemplate_idmamonsu zabbix template exportfile

ManageZabbix templates using one of the actions described inthe section called “Zabbix Server Actions”.

[--config] [--daemonize]

Syntax:

mamonsu [-cconfig_file | --config=config_file]        [-d | --daemonize]

Start working as a monitoring agent in the foreground or in the background using configuration parameters loaded from the configuration file. If the specified or default configuration file does not exist, exit with an error. Useful for debugging. You can specify the following options:

--version

Syntax:

mamonsu --version

Displaymamonsu version.

--help

Syntax:

mamonsu --help

Displaymamonsu command-line help.

Connection Options#

connection_options provide command-line connection parameters for the targetPostgres Pro cluster.connection_options can be--host,--port,--dbname (-d),--username (-U), and--password (-W). The--dbname option should specify themamonsu_database created for monitoring purposes. Note that the--username (-U) option must specify a superuser that can access the cluster.

If you omitconnection_options,mamonsu checks the configuration file for the needed settings.

Zabbix Server Actions#

Usingmamonsu, you can control some of theZabbix server functionality from the command line. Specifically, you can create or deleteZabbix hosts and host groups, as well as generate, import, and deleteZabbix templates using one of the following commands. Theobject_name to use must correspond to the type of theZabbix object specified in the command:template,host, orhostgroup.

• connection parameters

• logging parameters

• plugin parameters

Connection Parameters#

Logging Parameters#

Plugin Parameters#

Individual Plugin Sections#

All built-in plugins are installed along withmamonsu. To configure a built-in plugin you should find a corresponding section below theIndividual Plugin Sections heading and edit its parameter values:

The example below shows individual plugin sections corresponding to thepreparedtransaction and thepgprobackup built-in plugins:

[preparedtransaction]max_prepared_transaction_time = 60interval = 60[pgprobackup]enabled = falseinterval = 300backup_dirs = /backup_dir1,/backup_dir2pg_probackup_path = /usr/bin/pg_probackup-11

Collecting and Viewing Metrics Data#

Once started,mamonsu begins collecting system andPostgres Pro metrics. Theagent command enables you to get an overview of the collected metrics from the command line in real time.

To view the list of available metrics, use theagent metric-list command:

mamonsu agent metric-list

The output of this command provides the item key of each metric, its latest value, and the time when this value was received. For example:

system.memory[active]      7921004544    1564570818system.memory[swap_cache]      868352    1564570818pgsql.connections[idle]           6.0    1564570818pgsql.archive_command[failed_trying_to_archive]    0    1564570818

To view the current value for a specific metric, you can use theagent metric-get command:

mamonsu agent metric-getmetric_name

wheremetric_name is the item key of the metric to monitor, as returned by themetric-list command. For example,pgsql.connections[idle].

You can view graphs for the collected metrics in theZabbix web interface under theGraphs menu. For details on working withZabbix, see its official documentation athttps://www.zabbix.com/documentation/current/manual.

If you have chosen to save all the collected metrics data into a file, as explained inthe section called “Logging Parameters”, you can later upload these metrics onto a Zabbix server for visualization using theupload command.

Adding Custom Plugins#

You can extendmamonsu with your own custom plugins, as follows:

TuningPostgres Pro and System Configuration

Based on the collected metrics data,mamonsu can tune yourPostgres Pro and system configuration for optimal performance.

You can get detailed information about the hardware, operating system, memory usage and other parameters of the monitored system, as well asPostgres Pro configuration, as follows:

mamonsu report

To view the suggested optimizations without applying them, run thetune command with the--dry-run option:

mamonsu tune --dry-run

To apply all the suggested changes, run thetune command without any parameters:

mamonsu tune

You can exclude some settings from the report or disable some of the optimizations by passing optional parameters. Seethe section called “Command-Line Reference” for the full list of parameters available forreport andtune commands.

ManagingZabbix Server Settings from the Command Line#

mamonsu enables you to work with theZabbix server from the command line. You can upload template files toZabbix, create and deleteZabbix hosts and host groups, link templates with hosts and check the latest metric values.

To set up yourZabbix host from scratch, you can follow these steps:

Once yourZabbix host is configured, complete the setup of your monitoring system as explained inthe section called “Installation and Setup”.

Exporting Metrics for NativeZabbix Agent

Usingmamonsu, you can convert system andPostgres Pro metrics definitions to the format supported by the nativeZabbix agent.

This feature currently has the following limitations:

To collect metrics provided bymamonsu using the nativeZabbix agent, do the following:

• If you need to retain the collected data, do the following:

  1. Install the new version ofmamonsu.

  2. Generate a new template for theZabbix server.

  3. If you performed a bootstrap using the previous version ofmamonsu, run thebootstrap command again.

  4. Upload the new template to theZabbix server.

  5. Rename the host for which you want to retain the collected data and leave the old template linked to that host.

  6. Create a new host for the same system and link the new template to it.

  7. Restartmamonsu. It will collect data for the new host. The old host will no longer be used, but the data collected will be available.

• If you do not need to retain the collected data, do the following:

  1. Install the new version ofmamonsu.

  2. Generate a new template for theZabbix server.

  3. If you performed a bootstrap using the previous version ofmamonsu, run thebootstrap command again.

  4. Upload the new template to theZabbix server.

  5. In the settings of theZabbix host, link the new template to the host instead of the old one.

  6. Restartmamonsu. It will start collecting data. All the data collected earlier will be lost.