Difference between revisions of "RCUG 1 Introducing RootCause"
m |
m |
||
| Line 2: | Line 2: | ||
<!-- <div><div> --> | <!-- <div><div> --> | ||
| − | [[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index| | + | [[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]] |
| − | |||
| − | Index]] [[RCUG_Top|Top]] | ||
'''RootCause User Guide''' | '''RootCause User Guide''' | ||
| Line 42: | Line 40: | ||
== What Is RootCause? == | == What Is RootCause? == | ||
| − | RootCause is a sophisticated tool designed to help software organizations solve 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. |
| − | |||
| − | problem as quickly as possible, ideally from a single occurrence, while | ||
| − | |||
| − | simultaneously reducing support costs. Fundamental to this is a tracing capability. | ||
| − | |||
| − | |||
| − | |||
| − | analysis as simple as possible | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The application | + | 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. | |
| − | computer, without access to the development environment. | + | 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 | You can choose to | ||
<!-- <A NAME=MARKER-2-154></A> --> | <!-- <A NAME=MARKER-2-154></A> --> | ||
| − | deploy the RootCause trace to the application environment after a problem occurs, | + | 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. |
| − | |||
| − | 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | afterwards. | + | 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. |
<!-- | <!-- | ||
| Line 105: | Line 59: | ||
== Java, C++, or Both? == | == Java, C++, or Both? == | ||
| − | RootCause is packaged as '''RootCause for Java''' and '''RootCause for C++'''. This | + | RootCause is packaged as '''RootCause for Java''' and '''RootCause for C++'''. This is the user's guide for the |
| − | is the user's guide for the | ||
<!-- <A NAME=MARKER-10-155></A> --> | <!-- <A NAME=MARKER-10-155></A> --> | ||
| − | '''C++''' version only. You should read the documentation and do the demos that | + | '''C++''' version only. You should read the documentation and do the demos that correspond to the version of RootCause you're interested in. |
| − | |||
| − | correspond to the version of RootCause you're interested in. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | more information see | + | 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 |
[[RCUG_2_Installing_RootCause#Licensing|"Licensing"]] | [[RCUG_2_Installing_RootCause#Licensing|"Licensing"]] | ||
[]<A HREF="rcc-5.html#MARKER-9-259">"Licensing"</A>, and | []<A HREF="rcc-5.html#MARKER-9-259">"Licensing"</A>, and | ||
| − | [[RCUG_7_Selected_Topics#Tracing_Java_and_C++_In_One_Program|"Tracing Java and | + | [[RCUG_7_Selected_Topics#Tracing_Java_and_C++_In_One_Program|"Tracing Java and C++ In One Program"]] |
| − | + | []<A HREF="rcc-13.html#MARKER-9-2192">"Tracing Java and C++ In One Program"</A>. | |
| − | C++ In One Program"]] | ||
| − | []<A HREF="rcc-13.html#MARKER-9-2192">"Tracing Java and C++ In One | ||
| − | |||
| − | Program"</A>. | ||
<!-- | <!-- | ||
| Line 143: | Line 80: | ||
on the Unix | on the Unix | ||
<!-- <A NAME=MARKER-10-158></A> --> | <!-- <A NAME=MARKER-10-158></A> --> | ||
| − | platform. Your feedback is desired, both on problems that you encounter and on | + | 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. |
| − | |||
| − | 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 [mailto:support@ocsystems.com support@ocsystems.com] | Please e-mail feedback to [mailto:support@ocsystems.com support@ocsystems.com] | ||
<!-- <A HREF="mailto:support@ocsystems.com">support@ocsystems.com</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 | + | and indicate what version of RootCause you are using. The version number can be obtained |
| − | |||
| − | obtained | ||
<!-- <A NAME=MARKER-10-161></A> --> | <!-- <A NAME=MARKER-10-161></A> --> | ||
with the command <CODE>rootcause help</CODE>. | with the command <CODE>rootcause help</CODE>. | ||
| − | If you are evaluating RootCause, or you are a first time user, we suggest that you | + | 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 |
| − | |||
| − | install RootCause in a local directory (no special system administrator privileges | ||
| − | |||
| − | are needed) and do the demonstrations outlined in | ||
[[RCUG_5_RootCause_Demo|CHAPTER 5 - "RootCause Demo"]]. | [[RCUG_5_RootCause_Demo|CHAPTER 5 - "RootCause Demo"]]. | ||
| − | <!-- []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, "RootCause | + | <!-- []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, "RootCause Demo"</A>. --> |
| − | + | Then return to this manual to get specific questions answered. If the information is not clear, let us know. | |
| − | Demo"</A>. --> | ||
| − | Then return to this manual to get specific questions answered. If the information | ||
| − | |||
| − | is not clear, let us know. | ||
[[RCUG_2_Installing_RootCause|CHAPTER 2 - "Installing RootCause"]] | [[RCUG_2_Installing_RootCause|CHAPTER 2 - "Installing RootCause"]] | ||
| − | <!-- []<A HREF="rcc-5.html#MARKER-9-205">Chapter 2, "Installing | + | <!-- []<A HREF="rcc-5.html#MARKER-9-205">Chapter 2, "Installing RootCause"</A> --> |
| − | |||
| − | RootCause"</A> --> | ||
discusses the installation of RootCause. | discusses the installation of RootCause. | ||
| − | [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - "Terminology and | + | [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - "Terminology and Concepts"]] |
| − | + | <!-- []<A HREF="rcc-6.html#MARKER-9-335">Chapter 3, "Terminology and Concepts"</A> --> | |
| − | 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-335">Chapter 3, "Terminology and | ||
| − | |||
| − | Concepts"</A> --> | ||
| − | introduces some terminology and concepts that RootCause users should know to make | ||
| − | |||
| − | best use of the product. This chapter also contains a | ||
[[RCUG_3_Terminology_and_Concepts#Glossary|Glossary]] | [[RCUG_3_Terminology_and_Concepts#Glossary|Glossary]] | ||
[]<A HREF="rcc-6.html#MARKER-9-386">Glossary</A>. | []<A HREF="rcc-6.html#MARKER-9-386">Glossary</A>. | ||
[[RCUG_4_Getting_Started|CHAPTER 4 - "Getting Started"]] | [[RCUG_4_Getting_Started|CHAPTER 4 - "Getting Started"]] | ||
| − | <!-- []<A HREF="rcc-7.html#MARKER-9-508">Chapter 4, "Getting | + | <!-- []<A HREF="rcc-7.html#MARKER-9-508">Chapter 4, "Getting Started"</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. | |
| − | Started"</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. | ||
[[RCUG_5_RootCause_Demo|CHAPTER 5 - "RootCause Demo"]] | [[RCUG_5_RootCause_Demo|CHAPTER 5 - "RootCause Demo"]] | ||
| − | <!-- []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, "RootCause Demo"</A> | + | <!-- []<A HREF="rcc-8.html#MARKER-9-707">Chapter 5, "RootCause Demo"</A> --> |
| − | |||
| − | --> | ||
demonstrates how to apply RootCause to a simple program. | demonstrates how to apply RootCause to a simple program. | ||
| − | [[RCUG_6_Deploying_The_RootCause_Workspace|CHAPTER 6 - "Deploying the | + | [[RCUG_6_Deploying_The_RootCause_Workspace|CHAPTER 6 - "Deploying the RootCause Workspace"]] |
| − | + | <!-- []<A HREF="rcc-9.html#MARKER-9-873">Chapter 6, "Deploying the RootCause Workspace"</A> --> | |
| − | 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. |
| − | <!-- []<A HREF="rcc-9.html#MARKER-9-873">Chapter 6, "Deploying the RootCause | ||
| − | |||
| − | Workspace"</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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Environment Variables"</A> --> | + | [[RCUG_RootCause_Files_and_Environment_Variables|CHAPTER 7 - "RootCause Files and Environment Variables"]] |
| + | <!-- []<A HREF="rcc-10.html#MARKER-9-946">Chapter 7, "RootCause Files and Environment Variables"</A> --> | ||
discusses the environment variables | discusses the environment variables | ||
<!-- <A NAME=MARKER-10-162></A> --> | <!-- <A NAME=MARKER-10-162></A> --> | ||
| Line 223: | Line 122: | ||
[[RCUG_RootCause_GUI_Reference|CHAPTER 8 - "RootCause GUI Reference"]] | [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - "RootCause GUI Reference"]] | ||
| − | <!-- []<A HREF="rcc-11.html#MARKER-9-1320">Chapter 8, "RootCause GUI | + | <!-- []<A HREF="rcc-11.html#MARKER-9-1320">Chapter 8, "RootCause GUI Reference"</A> --> |
| − | + | describes the RootCause Graphical User Interface in detail, briefly describing each dialog, menu item, and button. | |
| − | Reference"</A> --> | ||
| − | describes the RootCause Graphical User Interface in detail, briefly describing each | ||
| − | |||
| − | dialog, menu item, and button. | ||
| − | [[RCUG_RootCause_Command_Reference|CHAPTER 9 - "RootCause Command | + | [[RCUG_RootCause_Command_Reference|CHAPTER 9 - "RootCause Command Reference"]] |
| − | + | <!-- []<A HREF="rcc-12.html#MARKER-9-2008">Chapter 9, "RootCause Command Reference"</A> --> | |
| − | Reference"]] | ||
| − | <!-- []<A HREF="rcc-12.html#MARKER-9-2008">Chapter 9, "RootCause Command | ||
| − | |||
| − | Reference"</A> --> | ||
describes the <CODE>rootcause</CODE> command line. | describes the <CODE>rootcause</CODE> command line. | ||
[[RCUG_7_Selected_Topics|CHAPTER 10 - "Selected Topics"]] | [[RCUG_7_Selected_Topics|CHAPTER 10 - "Selected Topics"]] | ||
| − | <!-- []<A HREF="rcc-13.html#MARKER-9-2163">Chapter 10, "Selected | + | <!-- []<A HREF="rcc-13.html#MARKER-9-2163">Chapter 10, "Selected Topics"</A> --> |
| − | |||
| − | Topics"</A> --> | ||
contains technical discussions for issues of interest to RootCause users. | contains technical discussions for issues of interest to RootCause users. | ||
| Line 279: | Line 168: | ||
<!-- </div> --> | <!-- </div> --> | ||
| − | [[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index| | + | [[RCUG_2_Installing_RootCause|Next]] [[RCUG_0_Contents|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]] |
| − | |||
| − | Index]] [[RCUG_Top|Top]] | ||
[[Category:RCUG]] | [[Category:RCUG]] | ||
Revision as of 02:23, 13 September 2017
RootCause User Guide
Contents
Introducing RootCause
RCUG 1 Introducing RootCause
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 "Licensing" []<A HREF="rcc-5.html#MARKER-9-259">"Licensing"</A>, and "Tracing Java and C++ In One Program" []<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 Glossary []<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.