In addition to embedded scripting with Groovy and PowerShell, LogicMonitor provides support for external scripts using any scripting language. You can also use external scripting to execute any program on the Collector directly and use its output to collect data.

Requirements for Configuring External Scripting

To configure an external script, you must have the following:

• A user role with access to Modules.
  For more information, see LogicMonitor Roles
• A new or existing resource or resources to which the script applies.
• A script file in your preferred language.
  For example, the following is a sample Perl script named tomcat_log_size.pl written to take a single argument that contains the Tomcat root directory.

#!/usr/bin/perl
use warnings;
use strict;
# ingest the single argument into a single variable
my ($tomcatRoot) = @ARGV;
# run the "stat" function on the filename and collect the output as an array
my @result = stat("$tomcatRoot/logs/catalina.out");
# exit with a non-zero code if we didn't get a valid result from stat
if (!@result) {
    exit 1;
}
# the 7th element in the array is size in bytes; print this out
print $result[7];
# exit to indicate we got a valid result
exit 0;

To test the script, run the following on the command line:
$ ./tomcat_log_size.pl /usr/local/tomcat 3710925

Configuring External Scripting for a DataSource

1. In LogicMonitor, navigate to Modules.
2. Choose an existing DataSource or create a new one. For more information, see Creating a DataSource.
   For example, create a resource property named tomcat.root on each resource where you want to monitor the Tomcat log file.
   For more information, see Resource and Instance Properties.
3. In the Summary section, select “SCRIPT” from the Collection Method dropdown menu.
   
4. In the Collection section, select “Upload script File” from the Script Type dropdown menu.
5. Select Upload Script and upload your custom script file.
   External scripts are installed onto the agent, local, or bin subdirectory within the LogicMonitor Collector. If you have multiple scripts (for example, one Linux and one Windows), upload both, one after the other.
   

6. In the Windows script name/path and/or Linux/Unix script name/path fields, provide the name of the uploaded script.
   For example, the sample tomcat_log_size.pl script would use the following details:
   • In the Linux/Unix script name/path field, enter “tomcat_log_size.pl” as the file name.

7. In the Windows arguments and/or Linux/Unix arguments fields, enter any arguments to pass to your script.
   When passing multiple parameters, provide each argument individually and separate by whitespace. Do not use double quotes to enclose your argument string.
   For example, the sample tomcat_log_size.pl script would use ##tomcat.root## in the Linux/Unix arguments field.

8. (Optional) Select Test Script to confirm the script and any applied arguments function properly.
9. (Optional) Add or edit normal and complex datapoints to capture values from the monitored resource. For more information, see Normal Datapoints and Complex Datapoints.
   For example, to create a normal datapoint for the sample tomcat_log_size.pl script, do the following:
   1. In Normal Datapoints, select Add a Normal Datapoint.
   2. In the Interpret output with dropdown menu, select “no interpretation; use directly.” as the script is returning only a single value.

3. Select Add Static Threshold. Configure the following fields to alert when the datapoint exceeds 1 GB.
   1. In Time Range, set a time range to monitor each day.
   2. In the When field, select Value.
   3. Select “(>) Greater than.” in the Is field.  Choose an alert severity, and enter “1” in the corresponding field.
   4. Select Apply.

10. Select Save.

Your DataSource will appear in the Modules list.

Configuring External Scripting for a ConfigSource

1. In LogicMonitor, navigate to Modules.
2. Choose an existing ConfigSource or create a new one.
   For more information, see Creating ConfigSources.
3. In the Summary section, select “SCRIPT” from the Collection Method dropdown menu.
   
4. In the Collection section, select “Upload script File” from the Script Type dropdown menu.
5. Select Upload Script and upload your custom script file.
   External scripts are installed onto the agent/local/bin/ subdirectory within the LogicMonitor Collector. If you have multiple scripts (for example, one Linux and one Windows), upload both, one after the other.
   

6. In the Windows script name/path and/or Linux/Unix script name/path fields, provide the name of the uploaded script.

7. In the Windows arguments and/or Linux/Unix arguments fields, enter any arguments to pass to your script.
   When passing multiple parameters, provide each argument individually and separate by whitespace. Do not use double quotes to enclose your argument string.

8. (Optional) Select Test Script to confirm the script and any applied arguments function properly.
9. (Optional) Add or edit config checks as needed. For more information, see Config Checks.
10. Select Save.

Your ConfigSource will appear in the Modules list.