Collecting output received by executing a script locally
To collect output received by executing a script locally, you need to create the Monitor Script Output on Collection Agent data collector.
If you have data stored in a database or another product repository and this data is unavailable via log files, you can collect data by using this data collector.
This data collector cannot be used 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.
To locally collect output received by executing a script
- 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)
Type or select the collection host depending on whether you want to use the Collection Station or the Collection Agent to perform data collection.
The collection host is the computer on which the Collection Station or the Collection Agent is located.
By default, the Collection Station is already selected. You can either retain the default selection or select the Collection Agent.
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 (").
Additional information: If you specify a Microsoft Windows script that sets the data and time dynamically, the product uses the date and time format used by the associated service. The date and time format used by the service might be different from the user's local date and time format. In such a case, you must change the date and time format for all users in the registry. For more information, see http://support.microsoft.com/kb/241671.
Example of a script that sets the date and time dynamically:
@echo off
set mydate=%DATE:~0,4%/%DATE:
~5,2%/%DATE:~8,2%
echo [%mydate% %time%] [WARNING] [TID:0000003056]
: CommitCache
echo [%mydate% %time%] [WARNING] [TID: 0000003056]
: ModifyWithoutLongWait
echo [%mydate% %time%] [WARNING] [TID: 0000003056]
: LongWaitTime Zone
Data Pattern
Pattern
Date Format
Date Locale
(Optional) You can use this setting to enable reading the date and time string based on the language selected. Note that this setting only applies to those portions of the date and time string that consist letters (digits are not considered).
By default, this value is set to English.
You can manually select a language to override the default locale. For a list of languages supported, see Language-information.
File Encoding
If your data file uses a character set encoding other than UTF-8 (default), then do one of the following:
- Filter the relevant character set encodings that match the file.
To do this, click Filter relevant charset encodingnext to this field.
- Manually scan through the list available and select an appropriate option.
- Allow TrueSight IT Data Analytics to use a relevant character set encoding for your file by manually select the AUTO option.
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.
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.
The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.
- Filter the relevant character set encodings that match the file.
Click Create to save your changes.
(Optional) You can use this setting to enable reading the date and time string based on the language selected. Note that this setting only applies to those portions of the date and time string that consist letters (digits are not considered).
By default, this value is set to English.
You can manually select a language to override the default locale. For a list of languages supported, see Language-information.