Fortinet Document Library

Version:


Table of Contents

User Guide

21.4.0
Copy Link

Integrate with Domino

Integrating Domino with FortiMonitor

Make sure that you have the appropriate permissions on the directory used to write the domino statistics. The FortiMonitor agent needs to be able to read and remove files from the directory you designated.

Install the Agent

To integrate Domino with FortiMonitor, you must first install the FortiMonitor Agent. The steps are detailed in Install the FortiMonitor Agent

If you are installing the Linux Agent, make sure to append --custom-metrics at the end of the standalone installer command.

Create the directories where Domino will post the output

Domino will output statistics files that the FortiMonitor Agent will pick up. These are stored in a sub-folder under the Domino installation directory. You need to create these folders before modifying the Domino Notes.ini file.

For example, from the directory C:\Program Files\IBM\Domino\data you will need to create: stats\Panopta\custom_metrics\.

Modify Notes.ini

After installing the Agent and creating the folder where Domino will write output statistics, you can now edit your Domino server's notes.ini file and add the following content. 

For Linux

Add the following to the Notes.ini file.

STATPUB_ENABLE=1
STATPUB_URI=file:///../../usr/share/panopta-agent/incoming/dominostats_$Timestamp$
STATPUB_HEADERS=Content-type: application/json
STATPUB_DATA_HEAD={"agent_payload_version": 1.0, "plugin_textkey": "com.pnp-hcl.dominostats", "plugin_category_name": "Domino Statistics", "metrics": [$Newline$
STATPUB_METRIC_FORMAT={"textkey": "$Name$", "label": "$Name$", "value": $Value$, "unit": "(units)", "timestamp": "$Timestamp$"}
STATPUB_DELTA_METRIC_FORMAT={"textkey": "Rate.$Name$", "label": "$Name$ Rate", "value": $Value$, "unit": "(units per minute)", "timestamp": "$Timestamp$"}
STATPUB_METRIC_DELIMITER=,$Newline$
STATPUB_DATA_TAIL=$Newline$]}

For Windows

  1. Add the following to the Notes.ini file.
    Note: The STATPUB_URI needs to be a relative path in relation to your Domino install. The installation below assumes Domino is installed in C:\.


STATPUB_ENABLE=1
STATPUB_URI=file:///stats\Panopta\custom_metrics\domino_stats_$Timestamp$
STATPUB_HEADERS=Content-type:application/json
STATPUB_DATA_HEAD={"agent_payload_version": 1.0, "plugin_textkey": "com.pnp-hcl.dominostats", "plugin_category_name": "Domino Statistics", "metrics": [$Newline$
STATPUB_METRIC_FORMAT={"textkey": "$Name$", "label": "$Name$", "value": $Value$, "unit": "(units)", "timestamp": "$Timestamp$"}
STATPUB_DELTA_METRIC_FORMAT={"textkey": "Rate.$Name$", "label": "$Name$ Rate", "value": $Value$, "unit": "(units per minute)", "timestamp": "$Timestamp$"}
STATPUB_METRIC_DELIMITER=,$Newline$
STATPUB_DATA_TAIL=$Newline$]}

2. Edit the FortiMonitor agent config file. You can find it in C:\Program Files (x86)\PanoptaAgent.

3. Add the Domino output path to the <service> field:

<add key="MetricIncomingDirectory" value="C:\Program Files\IBM\Domino\data\stats\Panopta\custom_metrics" />

For example:


<agent>
<service>
<add key="AggregatorUrl" value="https://aggregator2.panopta.com/v20.11" />
<add key="ServerKey" value="xxxx-yyyy-zzzz-0000" />
<add key="MaintenanceDuration" value="" />
<add key="ShowPublicStatus" value="" />
<add key="EnableCounterMeasures" value="true" />
<add key="CounterMeasuresRemotePlugins" value="" />
<add key="CounterMeasuresRefreshPlugins" value="" />
<add key="MetricIncomingDirectory" value="C:\Program Files\IBM\Domino\data\stats\Panopta\custom_metrics" />
<!--
<add key="DiscoveryCheckInterval" value="300" />
<add key="MetricResultsQueueMax" value="7000" />
<add key="EnableAlertCheckDelay" value="False" />
<add key="PluginBlacklist" value="" />
-->
</service>

4. Restart the FortiMonitor Windows Agent service after changing this setting.

Troubleshooting

Unable to see Domino metric data

If you do not see any Domino metric data in your control panel:

  1. Check that you have modified the notes.ini file correctly. See Modify Notes.ini.

  2. Restart the Domino service after saving the file. 

  3. Make sure the FortiMonitor Agent is able to read the files and write to the directory.

  4. Ensure that the folders where Domino writes the output have been created and the path is correctly set. See Create the directories where Domino will post the output.

Failed to POST metric data error message

If you see the following error:

[001927:000182-00007F86E4D13700] 03-01-2020 08:00:16.46 StatPubFlushPostData> Failed to POST metric data using URI: 'file:///../../usr/share/panopta-agent/incoming/1578034816'; Cannot write or create file (file or disk is read-only)

Make sure that you have the appropriate permissions on the directory used to write the domino statistics. The FortiMonitor agent needs to be able to read and remove files from the directory you designated. 

If you see the following error:

001927:000182-00007F86E4D13700] 03-01-2020 07:58:16.45 StatPubFlushPostData> Failed to POST metric data using URI: 'file:///../../usr/share/panopta-agent/incoming'; Is a directory

Make sure that the URI ends with a file.

Unable to create the STATPUB_URI file

If you are having trouble getting the STATPUB_URI file written:

  1. Add STATPUB_DEBUG=1 to your notes.ini for more diagnostic information.

  2. Restart the Domino service after saving the file.

  3. Check the Domino log files for errors.

Integrate with Domino

Integrating Domino with FortiMonitor

Make sure that you have the appropriate permissions on the directory used to write the domino statistics. The FortiMonitor agent needs to be able to read and remove files from the directory you designated.

Install the Agent

To integrate Domino with FortiMonitor, you must first install the FortiMonitor Agent. The steps are detailed in Install the FortiMonitor Agent

If you are installing the Linux Agent, make sure to append --custom-metrics at the end of the standalone installer command.

Create the directories where Domino will post the output

Domino will output statistics files that the FortiMonitor Agent will pick up. These are stored in a sub-folder under the Domino installation directory. You need to create these folders before modifying the Domino Notes.ini file.

For example, from the directory C:\Program Files\IBM\Domino\data you will need to create: stats\Panopta\custom_metrics\.

Modify Notes.ini

After installing the Agent and creating the folder where Domino will write output statistics, you can now edit your Domino server's notes.ini file and add the following content. 

For Linux

Add the following to the Notes.ini file.

STATPUB_ENABLE=1
STATPUB_URI=file:///../../usr/share/panopta-agent/incoming/dominostats_$Timestamp$
STATPUB_HEADERS=Content-type: application/json
STATPUB_DATA_HEAD={"agent_payload_version": 1.0, "plugin_textkey": "com.pnp-hcl.dominostats", "plugin_category_name": "Domino Statistics", "metrics": [$Newline$
STATPUB_METRIC_FORMAT={"textkey": "$Name$", "label": "$Name$", "value": $Value$, "unit": "(units)", "timestamp": "$Timestamp$"}
STATPUB_DELTA_METRIC_FORMAT={"textkey": "Rate.$Name$", "label": "$Name$ Rate", "value": $Value$, "unit": "(units per minute)", "timestamp": "$Timestamp$"}
STATPUB_METRIC_DELIMITER=,$Newline$
STATPUB_DATA_TAIL=$Newline$]}

For Windows

  1. Add the following to the Notes.ini file.
    Note: The STATPUB_URI needs to be a relative path in relation to your Domino install. The installation below assumes Domino is installed in C:\.


STATPUB_ENABLE=1
STATPUB_URI=file:///stats\Panopta\custom_metrics\domino_stats_$Timestamp$
STATPUB_HEADERS=Content-type:application/json
STATPUB_DATA_HEAD={"agent_payload_version": 1.0, "plugin_textkey": "com.pnp-hcl.dominostats", "plugin_category_name": "Domino Statistics", "metrics": [$Newline$
STATPUB_METRIC_FORMAT={"textkey": "$Name$", "label": "$Name$", "value": $Value$, "unit": "(units)", "timestamp": "$Timestamp$"}
STATPUB_DELTA_METRIC_FORMAT={"textkey": "Rate.$Name$", "label": "$Name$ Rate", "value": $Value$, "unit": "(units per minute)", "timestamp": "$Timestamp$"}
STATPUB_METRIC_DELIMITER=,$Newline$
STATPUB_DATA_TAIL=$Newline$]}

2. Edit the FortiMonitor agent config file. You can find it in C:\Program Files (x86)\PanoptaAgent.

3. Add the Domino output path to the <service> field:

<add key="MetricIncomingDirectory" value="C:\Program Files\IBM\Domino\data\stats\Panopta\custom_metrics" />

For example:


<agent>
<service>
<add key="AggregatorUrl" value="https://aggregator2.panopta.com/v20.11" />
<add key="ServerKey" value="xxxx-yyyy-zzzz-0000" />
<add key="MaintenanceDuration" value="" />
<add key="ShowPublicStatus" value="" />
<add key="EnableCounterMeasures" value="true" />
<add key="CounterMeasuresRemotePlugins" value="" />
<add key="CounterMeasuresRefreshPlugins" value="" />
<add key="MetricIncomingDirectory" value="C:\Program Files\IBM\Domino\data\stats\Panopta\custom_metrics" />
<!--
<add key="DiscoveryCheckInterval" value="300" />
<add key="MetricResultsQueueMax" value="7000" />
<add key="EnableAlertCheckDelay" value="False" />
<add key="PluginBlacklist" value="" />
-->
</service>

4. Restart the FortiMonitor Windows Agent service after changing this setting.

Troubleshooting

Unable to see Domino metric data

If you do not see any Domino metric data in your control panel:

  1. Check that you have modified the notes.ini file correctly. See Modify Notes.ini.

  2. Restart the Domino service after saving the file. 

  3. Make sure the FortiMonitor Agent is able to read the files and write to the directory.

  4. Ensure that the folders where Domino writes the output have been created and the path is correctly set. See Create the directories where Domino will post the output.

Failed to POST metric data error message

If you see the following error:

[001927:000182-00007F86E4D13700] 03-01-2020 08:00:16.46 StatPubFlushPostData> Failed to POST metric data using URI: 'file:///../../usr/share/panopta-agent/incoming/1578034816'; Cannot write or create file (file or disk is read-only)

Make sure that you have the appropriate permissions on the directory used to write the domino statistics. The FortiMonitor agent needs to be able to read and remove files from the directory you designated. 

If you see the following error:

001927:000182-00007F86E4D13700] 03-01-2020 07:58:16.45 StatPubFlushPostData> Failed to POST metric data using URI: 'file:///../../usr/share/panopta-agent/incoming'; Is a directory

Make sure that the URI ends with a file.

Unable to create the STATPUB_URI file

If you are having trouble getting the STATPUB_URI file written:

  1. Add STATPUB_DEBUG=1 to your notes.ini for more diagnostic information.

  2. Restart the Domino service after saving the file.

  3. Check the Domino log files for errors.