Difference between revisions of "RCUG 4 Getting Started"

From OC Systems Wiki!
Jump to: navigation, search
m
m
Line 2: Line 2:
 
<!--  <div><div>  -->
 
<!--  <div><div>  -->
  
−
[[RCUG_5_RootCause_Demo|Next]] [[RCUG_3_Terminology_and_Concepts|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
+
[[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
  
 
'''RootCause User Guide'''
 
'''RootCause User Guide'''
Line 8: Line 8:
 
<!--  </div>  -->
 
<!--  </div>  -->
  
−
= Getting Started =
+
= Introducing RootCause =
  
 
----
 
----
Line 16: Line 16:
 
<!-- header -->      {{FULLPAGENAME}}
 
<!-- header -->      {{FULLPAGENAME}}
  
 +
rcc-4
  
−
 
+
<!--
−
 
 
−
 
 
−
<!--
 
 
<DIV>
 
<DIV>
−
<A NAME=HEADING7></A>
+
<A NAME=HEADING4></A>
−
 
 
 
<DIV>
 
<DIV>
−
<P><A HREF=rcc-8.html>[Next]</A>  
+
<P><A HREF=rcc-5.html>[Next]</A>  
−
<A HREF=rcc-6.html>[Previous]</A>  
+
<A HREF=rcc-3.html>[Previous]</A>  
 
<A HREF=rcc-1.html>[Top]</A>  
 
<A HREF=rcc-1.html>[Top]</A>  
 
<A HREF=rcc-3.html>[Contents]</A>  
 
<A HREF=rcc-3.html>[Contents]</A>  
−
<A HREF=rcc-14.html>[Index]</A></P> -->
+
<A HREF=rcc-14.html>[Index]</A></P>
−
 
 
 
<P>RootCause</P>
 
<P>RootCause</P>
−
 
+
</DIV>
−
<!--  </DIV>
+
<A NAME="LINK-01intro_rc.fm-firstpage"></A>
−
<A NAME="LINK-04start_rc.fm-firstpage"></A>
+
<A NAME=HEADING4-0></A>
−
<A NAME=HEADING7-0></A>
+
<A NAME="UID-01intro_rc.fm-864080"></A>  -->
−
<A NAME="UID-04start_rc.fm-949487"></A>
+
<!--  <H1>  <A NAME=MARKER-9-153></A> Introducing RootCause</H1>
−
<H1>  <A NAME=MARKER-9-508></A> Getting Started</H1> -->
 
−
 
 
 
----  <!--  <HR>  -->
 
----  <!--  <HR>  -->
 +
<!-- 
 +
<A NAME=HEADING4-1></A>
 +
<A NAME="UID-01intro_rc.fm-949214"></A>  -->
  
−
<!--  <A NAME=HEADING7-1></A>
+
== What Is RootCause? ==
−
<A NAME="UID-04start_rc.fm-949488"></A>  -->
 
  
−
<!-- <A NAME=MARKER-9-509></A>  -->
+
RootCause is a sophisticated tool designed to help software organizations solve a problem as quickly as possible, ideally from a single occurrence, while simultaneously reducing support costs. Fundamental to this is a tracing capability.  We have designed RootCause to make powerful application tracing and root cause analysis as simple as possible.
−
== The Setup Script ==
 
−
<!-- <A NAME=MARKER-10-510></A>  -->
 
  
−
Installation of RootCause from CD-ROM or compressed file is covered in  
+
The fundamental concept is that all of the data needed to debug an application problem is recorded in its RootCause workspace. The RootCause Console Graphical User Interface (GUI) allows you to choose the data to be collected and to navigate the collected data.
−
[]<A HREF="rcc-5.html#MARKER-9-205">Chapter 2, &quot;Installing RootCause&quot;</A>.
 
  
−
<!--  <A NAME=MARKER-10-511></A>
+
When an application problem occurs, the "user" sends the RootCause workspace to the support organization as the problem report. If the support organization has defined the trace correctly, this RootCause workspace contains sufficient information to do the root cause analysis of the problem. There's no need to recreate the problem or ask the user further questions.
−
After installation, but each time before you run RootCause, you will need to execute its setup script. This will set the necessary environment variables (e.g. APROBE, PATH, etc.).   This is typically done by each user's login script because it usually needs to be done only once per login session.
 
  
−
The RootCause installation automatically creates a setup script that must be executed before RootCause can be run.  This script is located in the root of the directory where RootCause was installed.
+
The RootCause Console tools are used in the application development and support environments to define what to trace and also ultimately to view the trace data. The application being traced may be run in the development environment as well, of course; or it may be run remotely, on a separate test platform or on a customer's computer, without access to the development environment.
  
−
For example, if you installed RootCause in directory <code>/opt/aprobe</code>, then you would execute the appropriate one of the following scripts to set up the environment before using RootCause. The first of these scripts is for ksh or bsh users; the other is for csh users:
+
You can choose to
 +
<!-- <A NAME=MARKER-2-154></A> -->
 +
deploy the RootCause trace to the application environment after a problem occurs, or you can include RootCause as part of your shipped application so that any time a problem occurs you can immediately examine the data collected by RootCause to perform a root cause analysis of the problem.
  
−
<pre>
+
Note that RootCause is designed to work on shipped applications. No change is needed to your application or your build processes!  The traces will be automatically inserted into your application when a copy of it is loaded into memory; the traces remain only while your application is running, and they vanish afterwards.
−
. /opt/aprobe/setup
 
  
−
or
+
<!--
−
 
+
<A NAME=HEADING4-8></A>
−
source  /opt/aprobe/setup.csh
+
<A NAME="UID-01intro_rc.fm-950330"></A>  -->
−
</pre>
+
== Java, C++, or Both? ==
−
 
 
−
You must execute this
 
−
<!-- <A NAME=MARKER-2-512></A>  -->
 
−
setup script in your shell every time you log in or otherwise reinitialize your environment.  Therefore it is a good idea to put the appropriate command above in your <code>~/.profile</code> (for Korn or Bourne shells) or ~/.login file (for C shell).  See <A HREF="rcc-12.html#MARKER-9-2009">"RootCause and Different Shells"</A> for information about other shells.</P>
 
−
 
 
−
This script defines the <code>APROBE</code> environment variable and appends<BR><CODE>$APROBE/bin</CODE> to your
 
−
<!-- <A NAME=MARKER-2-513></A>  -->
 
−
PATH environment variable.  It also sets defaults for both
 
−
<!--  <A NAME=MARKER-2-514></A>  -->
 
−
APROBE_REGISTRY and
 
−
<!--  <A NAME=MARKER-2-515></A>  -->
 
−
APROBE_LOG environment variables.  If the registry does not exist, the setup script will create a default one.
 
  
−
The setup script also defines aliases that are not inherited by subsequent non-login shells you may open, such as with the xterm command. To ensure that these aliases are defined (specifically rootcause_on and rootcause_off), you may add the command:
+
RootCause is packaged as '''RootCause for Java''' and '''RootCause for C++'''. This is the user's guide for the
 +
<!--  <A NAME=MARKER-10-155></A>  -->
 +
'''C++''' version only. You should read the documentation and do the demos that correspond to the version of RootCause you're interested in.
  
−
<pre>
+
The differences in features between '''RootCause for Java''' and '''RootCause for C++''' are determined solely by the license key(s) you are issued by OC Systems. If this isn't the version you want, or you want to use RootCause on native code libraries loaded by Java, or Java run as applets or beans from a compiled application, you will need licenses to enable both the Java and C++ features. For more information see
−
. $APROBE/setup.kshrc
+
[]<A HREF="rcc-5.html#MARKER-9-259">&quot;Licensing&quot;</A>, and
−
</pre>
+
[]<A HREF="rcc-13.html#MARKER-9-2192">&quot;Tracing Java and C++ In One Program&quot;</A>.
−
 
 
−
into your ~/.kshrc file if you are using Korn shell, or the command
 
−
 
 
−
<pre>
 
−
source $APROBE/setup.cshrc
 
−
</pre>
 
−
 
 
−
into your <code>~/.cshrc file</code> if you are using C shell.
 
−
 
 
−
Now you're ready to run RootCause.
 
  
 
<!--   
 
<!--   
−
<A NAME=HEADING7-17></A>
+
<A NAME=HEADING4-11></A>
−
<A NAME="UID-04start_rc.fm-949707"></A>  -->
+
<A NAME="UID-01intro_rc.fm-944228"></A>  -->
−
 
+
== About This Guide ==
−
== The RootCause Process ==
 
−
 
 
−
Using RootCause is typically an iterative process with the following pattern:
 
−
<OL>
 
−
 
 
−
<LI><P>Run your application in the normal way, but with RootCause enabled in its environment, for example:</P>
 
−
<A NAME=MARKER-2-516></A>rootcause<A NAME=MARKER-10-517></A>_on<BR>my_app_driver arg1 arg2<BR><A NAME=MARKER-10-518></A><A NAME=MARKER-2-519></A>rootcause<A NAME=MARKER-10-520></A>_off
 
−
 
 
−
<P>This will record information about the application in the <A HREF="rcc-10.html#MARKER-9-963">RootCause Log</A> file.</P>
 
−
 
 
−
<P>NOTE: On AIX, you must use "apaudit my_app_driver" in the above command instead of just "my_app_driver" to allow RootCause to log and trace your application.  See <A HREF="#MARKER-9-532">Enabling RootCause for an AIX Application</A> below.</P>
 
−
 
 
−
<LI><P>Start the RootCause Console GUI with the <CODE><A NAME=MARKER-2-521></A><A HREF="rcc-12.html#MARKER-9-2101">rootcause open</A></CODE> command. This will open the <A HREF="rcc-11.html#MARKER-9-1321">Workspace Browser</A> and the <A HREF="rcc-11.html#MARKER-9-1725">Trace Display</A> showing the contents of the <A NAME=MARKER-2-522></A>RootCause log file.</P>
 
−
 
 
−
<LI><P>Use <EM><A NAME=MARKER-2-523></A><A HREF="rcc-11.html#MARKER-9-1730">Open Associated Workspace</A></EM> on the application program listed in the RootCause log display, and approve the creation of the new workspace.</P>
 
−
 
 
−
<LI><P>Click <EM><A HREF="rcc-11.html#MARKER-9-1426">Setup</A></EM> and define the probes for the application by choosing what you want to trace in the <A NAME=MARKER-2-524></A><A HREF="rcc-11.html#MARKER-9-1531">Trace Setup Dialog</A>. Note that RootCause writes the probes to separate files, so the application itself remains totally unmodified.</P>
 
−
 
 
−
<LI><P>Execute the application as you normally would, but with rootcause "on", as in step 1 above. The application need not be executed from the RootCause GUI, although there is a convenience <EM><A HREF="rcc-11.html#MARKER-9-1428">Run</A></EM> button to do so. This makes it very simple to use RootCause, even if the application is deeply embedded in a complex system.</P>
 
−
 
 
−
<LI><P>Click the <EM><A HREF="rcc-11.html#MARKER-9-1431">Index</A></EM> button to bring up the index of data that was logged for the newest process in the workspace, and double-click on an item there to format the trace data collected by the probes, or you can use the <EM><A HREF="rcc-11.html#MARKER-9-1432">Examine</A></EM> button to directly select the data file(s) you wish to view.</P>
 
−
 
 
−
<LI><P>In the <A HREF="rcc-11.html#MARKER-9-1725">Trace Display</A> window that appears is a call tree. Here you can:</P>
 
−
 
 
−
<UL>
 
−
<LI><P>Use the <EM><A HREF="rcc-11.html#MARKER-9-1795">Find</A></EM> button to search for specific functions or events in the data.</P>
 
−
 
 
−
<LI><P>Select a node in the event tree and right-click to bring up the <EM><A HREF="rcc-11.html#MARKER-9-1826">Trace Display Popup Menu</A></EM>, from which you can disable traces and perform other operations.</P>
 
−
 
 
−
<LI><P>Select a <A NAME=MARKER-2-525></A>SYN_<A NAME=MARKER-10-526></A>CALL_COUNTS node and use <A HREF="rcc-11.html#MARKER-9-1761">Show Associated Table</A> to view and navigate to the function<A NAME=MARKER-10-527></A>s in the data file(s).</P>
 
−
 
 
−
<LI><P>Select a <A NAME=MARKER-2-528></A>LOAD_SHED<A NAME=MARKER-2-529></A><A NAME=MARKER-10-530></A> node and use <A HREF="rcc-11.html#MARKER-9-1761">Show Associated Table</A> to view the table of all function<A NAME=MARKER-10-531></A>s for which tracing was disabled due to <A HREF="rcc-6.html#MARKER-9-433">load shedding</A> during the run, and disable the tracing of these during subsequent runs.</P>
 
−
 
 
−
<LI><P>Save the output as Text or XML for off-line processing </P>
 
−
</UL>
 
−
 
 
−
<LI><P>When you have completed analyzing the data and modifying the trace to tune the information collected, go back to step 4 to trace parameters or add probe actions, or return to step 2 to choose another program to trace.</P>
 
−
</OL>
 
  
−
If you wish to run the probes on a remote computer, then there are additional steps to send a RootCause workspace to the remote computer before execution. These are discussed in detail in
+
This User's Guide describes version 2 of the RootCause product for
−
[]<A HREF="rcc-9.html#MARKER-9-873">Chapter 6, &quot;Deploying the RootCause Workspace&quot;</A>.
+
<!--  <A NAME=MARKER-10-156></A>  -->
 +
C/C++
 +
<!-- <A NAME=MARKER-10-157></A>  -->
 +
on the Unix
 +
<!--  <A NAME=MARKER-10-158></A> -->
 +
platform.  Your feedback is desired, both on problems that you encounter and on suggestions of how the product could better accomplish its goals of solving problems from a single occurrence and of reducing support costs.
  
−
This process is explored using a concrete example in the next chapter,
+
Please e-mail feedback to [mailto:support@ocsystems.com support@ocsystems.com]
−
[]<A HREF="rcc-8.html#MARKER-9-707">&quot;RootCause Demo&quot;</A>.
+
<!--  <A HREF="mailto:support@ocsystems.com">support@ocsystems.com</A>  -->
 +
and indicate what version of RootCause you are using. The version number can be obtained
 +
<!--  <A NAME=MARKER-10-161></A>  -->
 +
with the command <CODE>rootcause help</CODE>.
  
−
<!--   
+
If you are evaluating RootCause, or you are a first time user, we suggest that you install RootCause in a local directory (no special system administrator privileges are needed) and do the demonstrations outlined in
−
<A NAME=HEADING7-37></A>
+
[[RCUG_5_RootCause_Demo|CHAPTER 5 - &quot;RootCause Demo&quot;]].
−
<A NAME="UID-04start_rc.fm-958254"></A>  -->
+
<!--  []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, &quot;RootCause Demo&quot;</A>. -->
 +
Then return to this manual to get specific questions answered. If the information is not clear, let us know.
  
−
<!--  <A NAME=MARKER-9-532></A>  -->
+
[[RCUG_2_Installing_RootCause|CHAPTER 2 - &quot;Installing RootCause&quot;]]
−
== Enabling RootCause for an AIX Appli<B>c</B>ation ==
+
<!--  []<A HREF="rcc-5.html#MARKER-9-205">Chapter 2, &quot;Installing RootCause&quot;</A>  -->
 +
discusses the installation of RootCause.
  
−
<!-- <A NAME=MARKER-2-533></A>  -->
+
[[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - &quot;Terminology and Concepts&quot;]]
−
AIX provides no mechanism to cause a shared library to be automatically loaded into every application started. Therefore, the user must explicitly identify applications that are to be "intercepted" and recorded in the RootCause log, and subsequently traced using the process described in this document.
+
<!-- []<A HREF="rcc-6.html#MARKER-9-335">Chapter 3, &quot;Terminology and Concepts&quot;</A>  -->
 +
introduces some terminology and concepts that RootCause users should know to make best use of the product.  This chapter also contains a  
 +
[]<A HREF="rcc-6.html#MARKER-9-386">Glossary</A>.
  
−
To run an executable under RootCause from the command line:
+
[[RCUG_4_Getting_Started|CHAPTER 4 - &quot;Getting Started&quot;]]
 +
<!--  []<A HREF="rcc-7.html#MARKER-9-508">Chapter 4, &quot;Getting Started&quot;</A>  -->
 +
discusses how an individual user would set up to use RootCause after it is installed and gives a quick description of getting started with RootCause.
  
−
<!--  <A NAME=MARKER-2-534></A>  -->
+
[[RCUG_5_RootCause_Demo|CHAPTER 5 - &quot;RootCause Demo&quot;]]
−
<PRE>
+
<!--  []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, &quot;RootCause Demo&quot;</A>  -->  
−
$ rootcause run my_program -opt arg2
+
demonstrates how to apply RootCause to a simple program.
−
</PRE>
 
  
−
or
+
[[RCUG_6_Deploying_The_RootCause_Workspace|CHAPTER 6 - &quot;Deploying the RootCause Workspace&quot;]]
 +
<!--  []<A HREF="rcc-9.html#MARKER-9-873">Chapter 6, &quot;Deploying the RootCause Workspace&quot;</A>  -->
 +
explains how to define a RootCause trace session at your local site and then send it to a remote site to do remote debugging.
  
−
<!--  <A NAME=MARKER-2-535></A>  -->
+
[[RCUG_RootCause_Files_and_Environment_Variables|CHAPTER 7 - &quot;RootCause Files and Environment Variables&quot;]]
−
<PRE>
+
<!--  []<A HREF="rcc-10.html#MARKER-9-946">Chapter 7, &quot;RootCause Files and Environment Variables&quot;</A>  -->
−
$ rootcause on
+
discusses the environment variables
−
$ apaudit my_program -opt arg2
+
<!--  <A NAME=MARKER-10-162></A>  -->  
−
$ rootcause off
+
and files that affect RootCause.
−
</PRE>
 
  
−
If it is not possible to directly invoke the application's executable from the command-line, you can simply rename the
+
[[RCUG_RootCause_GUI_Reference|CHAPTER 8 - &quot;RootCause GUI Reference&quot;]]
−
<A HREF="rcc-6.html#MARKER-9-425">executable</A>  
+
<!--  []<A HREF="rcc-11.html#MARKER-9-1320">Chapter 8, &quot;RootCause GUI Reference&quot;</A>  -->
−
to have a <CODE>.exe</CODE> suffix, and replace it with a (soft-link to a) script which will invoke the real application. For example:
+
describes the RootCause Graphical User Interface in detail, briefly describing each dialog, menu item, and button.
  
−
<PRE>
+
[[RCUG_RootCause_Command_Reference|CHAPTER 9 - &quot;RootCause Command Reference&quot;]]
−
$ mv my_program my_program.exe
+
<!--  []<A HREF="rcc-12.html#MARKER-9-2008">Chapter 9, &quot;RootCause Command Reference&quot;</A>  -->
−
$ ln -s $APROBE/bin/run_with_apaudit my_program
+
describes the <CODE>rootcause</CODE> command line.
−
</PRE>
 
  
−
The <A NAME=MARKER-2-536></A><code>run_with_apaudit</CODE> script simply re-invokes the program with apaudit as in the second example above.
+
[[RCUG_7_Selected_Topics|CHAPTER 10 - &quot;Selected Topics&quot;]]
 +
<!--  []<A HREF="rcc-13.html#MARKER-9-2163">Chapter 10, &quot;Selected Topics&quot;</A> -->
 +
contains technical discussions for issues of interest to RootCause users.
  
−
When we use the phrase
+
<!--  <A NAME=MARKER-10-163></A>  -->
−
"<A HREF="rcc-6.html#MARKER-9-458">run with rootcause on</A>"
+
Problems and platform-specific issues are discussed in the  
−
we refer to any of the above mechanisms.
+
<!--  <A NAME=MARKER-2-164></A> -->
 +
Release Notes for the current release of the product.
  
−
To enable automatic RootCause actions for Java applications (i.e., those normally run with the "java" command), you must do this for the native <CODE>java executable. This is generally not necessary, since you can more easily change "java" to "apaudit java" at the point of invocation. However, if you want to enable RootCause in your central Java installation, you should contact OC Systems for assistance: different Java versions are configured differently.</CODE>
+
Check our web site at [http://www.ocsystems.com/ www.ocsystems.com]
 +
<!--  <A HREF="http://www.ocsystems.com/">www.ocsystems.com</A>  -->
 +
for  
 +
<!-- <A NAME=MARKER-2-167></A> -->
 +
white papers and the newest version of the product.
  
 
<!--   
 
<!--   
−
<A NAME="LINK-04start_rc.fm-lastpage"></A>
+
<A NAME="LINK-01intro_rc.fm-lastpage"></A>
 
</DIV>
 
</DIV>
−
<DIV>  -->
+
<DIV>   
−
 
 
 
----  <!--  <HR>  -->
 
----  <!--  <HR>  -->
−
 
 
<!--   
 
<!--   
−
<P><A HREF=rcc-8.html>[Next]</A>  
+
<P><A HREF=rcc-5.html>[Next]</A>  
−
<A HREF=rcc-6.html>[Previous]</A>  
+
<A HREF=rcc-3.html>[Previous]</A>  
 
<A HREF=rcc-1.html>[Top]</A>  
 
<A HREF=rcc-1.html>[Top]</A>  
 
<A HREF=rcc-3.html>[Contents]</A>  
 
<A HREF=rcc-3.html>[Contents]</A>  
Line 203: Line 156:
 
<P></P>
 
<P></P>
 
</DIV>  -->
 
</DIV>  -->
−
 
−
 
−
 
  
 
<!-- footer -->
 
<!-- footer -->
Line 212: Line 162:
  
 
Copyright 2006-2017 OC Systems, Inc.
 
Copyright 2006-2017 OC Systems, Inc.
 +
 
<!--  </div>  -->
 
<!--  </div>  -->
  
−
[[RCUG_5_RootCause_Demo|Next]] [[RCUG_3_Terminology_and_Concepts|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
+
[[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
−
 
 
  
 
[[Category:RCUG]]
 
[[Category:RCUG]]

Revision as of 20:33, 26 August 2017


Next Previous Index Top

RootCause User Guide


Introducing RootCause


     RCUG 4 Getting Started

rcc-4


What Is RootCause?

RootCause is a sophisticated tool designed to help software organizations solve a problem as quickly as possible, ideally from a single occurrence, while simultaneously reducing support costs. Fundamental to this is a tracing capability. We have designed RootCause to make powerful application tracing and root cause analysis as simple as possible.

The fundamental concept is that all of the data needed to debug an application problem is recorded in its RootCause workspace. The RootCause Console Graphical User Interface (GUI) allows you to choose the data to be collected and to navigate the collected data.

When an application problem occurs, the "user" sends the RootCause workspace to the support organization as the problem report. If the support organization has defined the trace correctly, this RootCause workspace contains sufficient information to do the root cause analysis of the problem. There's no need to recreate the problem or ask the user further questions.

The RootCause Console tools are used in the application development and support environments to define what to trace and also ultimately to view the trace data. The application being traced may be run in the development environment as well, of course; or it may be run remotely, on a separate test platform or on a customer's computer, without access to the development environment.

You can choose to deploy the RootCause trace to the application environment after a problem occurs, or you can include RootCause as part of your shipped application so that any time a problem occurs you can immediately examine the data collected by RootCause to perform a root cause analysis of the problem.

Note that RootCause is designed to work on shipped applications. No change is needed to your application or your build processes! The traces will be automatically inserted into your application when a copy of it is loaded into memory; the traces remain only while your application is running, and they vanish afterwards.

Java, C++, or Both?

RootCause is packaged as RootCause for Java and RootCause for C++. This is the user's guide for the C++ version only. You should read the documentation and do the demos that correspond to the version of RootCause you're interested in.

The differences in features between RootCause for Java and RootCause for C++ are determined solely by the license key(s) you are issued by OC Systems. If this isn't the version you want, or you want to use RootCause on native code libraries loaded by Java, or Java run as applets or beans from a compiled application, you will need licenses to enable both the Java and C++ features. For more information see []<A HREF="rcc-5.html#MARKER-9-259">"Licensing"</A>, and []<A HREF="rcc-13.html#MARKER-9-2192">"Tracing Java and C++ In One Program"</A>.

About This Guide

This User's Guide describes version 2 of the RootCause product for C/C++ on the Unix platform. Your feedback is desired, both on problems that you encounter and on suggestions of how the product could better accomplish its goals of solving problems from a single occurrence and of reducing support costs.

Please e-mail feedback to support@ocsystems.com and indicate what version of RootCause you are using. The version number can be obtained with the command rootcause help.

If you are evaluating RootCause, or you are a first time user, we suggest that you install RootCause in a local directory (no special system administrator privileges are needed) and do the demonstrations outlined in CHAPTER 5 - "RootCause Demo". Then return to this manual to get specific questions answered. If the information is not clear, let us know.

CHAPTER 2 - "Installing RootCause" discusses the installation of RootCause.

CHAPTER 3 - "Terminology and Concepts" introduces some terminology and concepts that RootCause users should know to make best use of the product. This chapter also contains a []<A HREF="rcc-6.html#MARKER-9-386">Glossary</A>.

CHAPTER 4 - "Getting Started" discusses how an individual user would set up to use RootCause after it is installed and gives a quick description of getting started with RootCause.

CHAPTER 5 - "RootCause Demo" demonstrates how to apply RootCause to a simple program.

CHAPTER 6 - "Deploying the RootCause Workspace" explains how to define a RootCause trace session at your local site and then send it to a remote site to do remote debugging.

CHAPTER 7 - "RootCause Files and Environment Variables" discusses the environment variables and files that affect RootCause.

CHAPTER 8 - "RootCause GUI Reference" describes the RootCause Graphical User Interface in detail, briefly describing each dialog, menu item, and button.

CHAPTER 9 - "RootCause Command Reference" describes the rootcause command line.

CHAPTER 10 - "Selected Topics" contains technical discussions for issues of interest to RootCause users.

Problems and platform-specific issues are discussed in the Release Notes for the current release of the product.

Check our web site at www.ocsystems.com for white papers and the newest version of the product.


Copyright 2006-2017 OC Systems, Inc.


Next Previous Index Top

Retrieved from "https://www.ocsystems.com/w/index.php?title=RCUG_4_Getting_Started&oldid=588"