Monitor script output on Collection Agent
You can create a data collector for monitoring data that is generated as a result of running a script on the remote computer.
You cannot use this data collector to collect data that is generated as a result of running the binary files (or executable files). For example, .exe files on the Windows platform.
Related topics
To configure script output as a data collector
- Navigate to Administration > Data Collectors > Add Data Collector
.
- In the Name box, provide a unique name to identify this data collector.
From the Type list, select Monitor Script Output on Collection Agent.
Provide the following information, as appropriate:Field
Description
Target/Collection Host
Collection Host (Agent)
Failed to execute the [excerpt-include] macro.
Note: For this type of data collector, the target host and collection host are expected to have same values.
Collector Inputs
Script Path
Provide the complete path to the script that you want to execute on the remote computer for retrieving data.
You can also pass parameters dynamically while executing the script.
For example, you can execute the following script that takes the input parameter as your name and prints "Hello."
Script example#!/bin/bash
echo "Hello $1"In this case, you must enter script.sh MyName in this field.
where:
script.sh is the name of the file in which you saved the preceding script.
MyName refers to the name that you want to pass as the input parameter.
Note: If there is a space character in your script path, then you must enclose the script path with double quotes (").
Time Zone
Data Pattern
Pattern
Date Format
Select a date format to use for indexing the timestamp in the data file.
To select an option, you can do one of the following:
- Filter the relevant data formats that match the file.
To find a list of relevant data patterns, click Filter Relevant Data Pattern and Date Formatnext to the Pattern field. Click Refresh
to refresh the filtered list and see the complete list of data patterns available.
- Manually scan through the list available and select a date format.
After selecting an option, click Preview parsed log entries
to preview the sample data entries parsed. By looking at the preview of records, you can understand how the data will be indexed and be made available for searching.
If you do not find a relevant date format, you can also create a new date format by selecting the Create new Date Format option.
Notes:
- If you select both – a pattern and a date format, then the date format specified takes precedence over the date format from the pattern that you selected. So the timestamp is indexed as per the specified date format, and the rest of the data is indexed as per the pattern.
- If you select only a date format, then the date format is used for indexing the timestamp, while the rest of the data is displayed in a raw format in your search results.
Script Time Out (mins)
Specify the time duration (in minutes) after which the script must time out. By default, this value is set to 1.
Poll Interval (mins)
Specify the interval (in minutes) after which the script must be executed and the script output data must be collected. By default, this value is set to 1.
If you want to execute the script only once and collect the output data, then specify the value of this field as 0.
The value of this field is passed as the last argument to the script.
Start/Stop Collection
(Optional) Select this check box if you want to start the data collection immediately.
- Filter the relevant data formats that match the file.
- Click Create to save your changes.