Skip to main content

Dynamics AX Database

Pack assets

Templates

The Monitoring Connector Dynamics AX Database brings a host template:

  • App-Dynamics-AX-Database-Mssql-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService Description
EDI-OrderApp-Dynamics-AX-EDI-Order-MSSQL-customCheck the EDI Order errors

The services listed above are created automatically when the App-Dynamics-AX-Database-Mssql-custom host template is used.

Collected metrics & status

Here is the list of services for this connector, detailing all metrics linked to each service.

Metric nameUnit
order.warning.countcount
order.critical.countcount

Prerequisites

You'll need access to the Microsoft Dynamics AX database server with a valid server name. In some cases, credentials such as a username and password may also be required depending on the existing security configuration.

Installing the monitoring connector

Pack

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-dynamics-ax-mssql
  1. Whatever the license type (online or offline), install the Dynamics AX Database connector through the Configuration > Monitoring Connector Manager menu.

Plugin

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Dynamics-Ax-Mssql

Using the monitoring connector

Using a host template provided by the connector

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the App-Dynamics-AX-Database-Mssql-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
MSSQLUSERNAMEUser name used to connect to the databaseUSERNAME
MSSQLPASSWORDPassword for the defined user namePASSWORD
MSSQLPORTDatabase Server Port1433
EXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). All options are listed here.
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
TIMEFRAMESet the timeframe to query in seconds (default: 14400)14400
FILTERMODULEFilter on module
FILTERCOMPANYFilter on company
FILTERPORTNAMEFilter on portname
CRITICALGORDERCRITThresholds
WARNINGORDERCRITThresholds
WARNINGORDERWARNThresholds
CRITICALORDERWARNThresholds
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.--verbose
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_dynamics_ax.pl \
--plugin=database::mssql::plugin \
--dyn-mode=apps::dynamics::ax::mode::ediorder \
--hostname=10.0.0.1 \
--port=1433 \
--username='USERNAME' \
--password='PASSWORD' \
--filter-module='' \
--filter-company='' \
--filter-portname='' \
--timeframe=14400 \
--warning-order-warning= \
--critical-order-warning= \
--warning-order-critical= \
--critical-order-critical= \
--verbose

The expected command output is shown below:

OK: warning: 48 critical: 24 | 'order.warning.count'=48;;;0;'order.critical.count'=24;;;0;

Troubleshooting

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_dynamics_ax.pl \
--plugin=database::mssql::plugin \
--list-mode

The plugin brings the following modes:

ModeLinked service template
backup-age [code]Not used in this Monitoring Connector
blocked-processes [code]Not used in this Monitoring Connector
cache-hitratio [code]Not used in this Monitoring Connector
collection [code]Not used in this Monitoring Connector
connected-users [code]Not used in this Monitoring Connector
connection-time [code]Not used in this Monitoring Connector
databases-size [code]Not used in this Monitoring Connector
dead-locks [code]Not used in this Monitoring Connector
ediorder [code]App-Dynamics-AX-EDI-Order-MSSQL-custom
failed-jobs [code]Not used in this Monitoring Connector
list-databases [code]Not used in this Monitoring Connector
locks-waits [code]Not used in this Monitoring Connector
name [code]Not used in this Monitoring Connector
page-life-expectancy [code]Not used in this Monitoring Connector
sql [code]Not used in this Monitoring Connector
sql-string [code]Not used in this Monitoring Connector
tables [code]Not used in this Monitoring Connector
transactions [code]Not used in this Monitoring Connector

Available options

Modes options

All available options for each service template are listed below:

OptionDescription
--hostnameHostname to query.
--portDatabase Server Port.
--serverAn alternative to hostname+port. \<server> will be looked up in the file freetds.conf.
--databaseSelect database .
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--sqlmodeThis plugin offers several ways to query the database (default: dbi). See --list-sqlmode.
--list-sqlmodeList all available sql modes.
--multipleEnable connecting to multiple databases (required by some specific modes such as replication).
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--datasourceDatabase server information, mandatory if the server's address and port are not defined in the corresponding options. The syntax depends on the database type.
--usernameUser name used to connect to the database.
--passwordPassword for the defined user name.
--connect-optionsAdd connection options for the DBI connect method. Format: name=value,name2=value2,...
--connect-queryExecute a query just after the connection.
--sql-errors-exitExpected status in case of DB error or timeout. Possible values are warning, critical and unknown (default).
--timeoutTimeout in seconds for connection.
--exec-timeoutTimeout in seconds for query execution
--warning- --critical-Thresholds. Can be: 'order-critical', 'order-warning'.
--timeframeSet the timeframe to query in seconds (default: 14400).
--filter-moduleFilter on module.
--filter-companyFilter on company.
--filter-portnameFilter on portname.

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_dynamics_ax.pl \
--plugin=database::mssql::plugin \
--dyn-mode=apps::dynamics::ax::mode::ediorder \
--help