Visible Workings > Ruby-Trace User's Guide

The Ruby-Trace User's Guide
Brian Marick

Contents

Simple Programs

Server Programs

API

Glossary

Simple contents

  1. Tracing simple programs introduces the key concepts and shows how to use Ruby-trace on programs that can be run from a command line (as opposed to server programs).
  2. Tracing servers shows features used on large programs composed of many subsystems.
  3. The API describes the main Ruby-trace classes.
  4. The glossary defines some key terms (which are also defined when they first occur).

Detailed contents

Tracing simple programs

A first example

The default trace object

Trace levels

The trace threshold

Invoking trace methods

Turning tracing on at launch time

Tracing server programs

Logging to disk

Controlling two destinations

Timestamped files

Backup files

Tracing subsystems independently (topics)

Easy access to topic objects

Connectors as topics

Themes

More on control of thresholds

API

Errors

Connector class

Topic class

Destination class

PrintingDestination class

BufferDestination class

LogfileDestination class

Formatter class

Message class

Theme class

Glossary


Contents

Simple Programs

Server Programs

API

Glossary

Please send comments on this document to marick@visibleworkings.com. The ruby-trace mailing list is at at http://groups.yahoo.com/group/ruby-trace.

Copyright © 2001 by Brian Marick. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, draft v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub).