// REMOVE ME!! Please keep first line an empty line to make sure, the ToC can be build correctly


= Name of the Monitor. Normally the name of the class without .java

A summary what the monitor is doing. When is the monitor up or down.

== Monitor Facts

[cols="1,7"]
|===
| Class Name
| `Name of the monitor class which has to be used in the poller-configuration.xml`
|===

== Configuration and Use

.Monitor specific parameters for the <MONITORNAME-HERE>
[cols="1,3,1"]
|===

| Parameter
| Description
| Default value

3+| *Required*

| my parameter 1
| This is a placeholder for the first required monitor parameter description.
If you have a very long description make a soft break at line 120
| `-`

3+| *Optional*

| my parameter 2
| This is a placeholder for the second optional monitor parameter description.
| default value

|===

This monitor implements the <<reference:service-assurance/introduction.adoc#ref-service-assurance-monitors-common-parameters, Common Configuration Parameters>>.

This is optional just if you can use variables in the configuration.

.Variables which can be used in the configuration
[cols="1,3"]
|===
| Variable
| Description

| ${variable1}
| Description for the first variable

| ${variable2}
| Description for the second variable

| ${variable3}
| Description for the third variable
|===

== Examples

Some example configuration how to configure the monitor in the `poller-configuration.xml`.

[source, xml]
----
<parameter key="args" value="-i {variable3} -t ${variable2}"/>
<parameter key="args" value="http://${variable1}/${variable2}/static"/>
----

_(Comment that monitor section is required.)_
You must include the `monitor` section in your configuration.

== (Optional) SystemExecuteMonitor versus GpMonitor

The SystemExecuteMonitor is the successor of the GpMonitor. The main differences are:

* Variable replacement for the parameter args
* There are no fixed arguments handed to the system-call
* The _SystemExecuteMonitor_ supports _RemotePoller_ deployment

To migrate services from the _GpMonitor_ to the _SystemExecuteMonitor_ it is required to alter the parameter args.
To match the arguments called `hoption` for the `hostAddress` and `toption` for the `timeoutInSeconds`.
The args string that matches the _GpMonitor_ call looks like this:

[source, xml]
----
<parameter key="my parameter 2" value="--hostname ${variable1} --timeout ${variable2}" />
----

To migrate the GpMonitor parameters `hoption` and `toption` just replace the `--hostname` and `--timeout` directly in the args key.
