How to Create new Trace Scripts to be used in Enterprise Vault when using Dtrace within the Administrators Console.

book

Article ID: 100001743

calendar_today

Updated On:

Resolution

It is possible to create additional custom scripts that are then selectable when creating a Trace within the VAC.  The commands are carriage return delimited and mirror commands commonly usable in Dtrace when run from command line.

1. Create a new text file.
2. Open the text file and add the Description and Commands:

Note: The filename will be used for the category when selecting a trace to perform in the VAC.

Example:
Here is an example DTrace file that is pre-configured with the Processes ArchiveTask, JournalTask, StorageArchive, StorageFileWatch and an Include filter for "time taken".

----- Data starts below -----

[Description]
Use this script to gather performance-related tracing information for Exchange archiving and Centera collections.
Components: ArchiveTask, StorageArchive, StorageFileWatch

[Commands]
set ArchiveTask v
set JournalTask v
set StorageArchive v
set StorageFileWatch v

filter
c i
+ "time taken"

exit
log ?

----- Data ends above -----

3. Save the file in Unicode format
4. Change the extension to .INI
5. Place the INI into \Scripts for Dtrace\ folder.

Description:
 
[Commands]
In the above example, under the Commands section, it is necessary to provide each command to be run in Dtrace.  
 
Set
Sets the individual processes followed by the level of logging (Ex. "v" stands for "verbose").  
 
Filter (Optional)
Once each process is specified, it is optional to set additional filters.  In the above example, by specifying "filter", this enters into the Filter submenu.  Following this, the command "c i" is an abbreviation for "clear includes".  "Includes" refer to the default lines which will normally be included in the Dtrace log. Defaults are "EV-", "EV:" and "EV~".  This is because all Dtrace lines will begin with one of these values.  By clearing these 'Include strings', this will stop Dtrace from logging lines with these values.
 
+/- (Optional)
This is within the context of the Filter submenu.  The "+" command adds a specified filter value, while "-" removes a specified filter value.  Multiple filters can be added here, each on a separate line.
 
Example:
In the above script, all of the default include filters are removed and a new filter is added for "time taken".  This Dtrace will ONLY log lines that has the phrase "time taken" in them.
 
Exit
The exit command is only necessary when exiting from a submenu, for example, the Filter submenu.  If not altering filters, the exit command is not required.

Notes:
   a. Do not change standard scripts.
   b. Copy and edit .ini file with different name.
   c. Prefix own scripts with "Custom - " for easy identification.
 

 

Issue/Introduction

Dtrace.exe is a troubleshooting utility for Veritas Enterprise Vault that allows the recording of process functions to determine causes to functionality issues or errors. This information is designed for EV 8.0 and above, the Dtrace utility has been integrated in the Vault Admin Console (VAC). With this integration, multiple custom Dtrace 'scripts' have been designed to assist in troubleshooting various common issues.