de.intarsys.tools.monitor.ITrace Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of isrt Show documentation

The basic runtime tools and interfaces for intarsys components.

There is a newer version: 4.11

/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.tools.monitor;

import java.util.logging.Level;

/**
 * A trace of {@link ISample} instances for a specific {@link IMonitor} .
 * 
 * 
 * A trace means recording samples (and tags) while executing. The trace is
 * later on aggregated in the {@link IMonitor}. The {@link IMonitor} may
 * additionally keep a list of recent traces.
 * 
 */
public interface ITrace {
	/**
	 * Take a sample and tag it with description. The sample is
	 * stored in addition to the "fix" start and stop sample.
	 * 
	 * @param level
	 */
	public ISample sample(Level level, String description);

	/**
	 * Add a key/value pair to this. This data is not interpreted
	 * by the monitor.
	 * 
	 * @param key
	 *            The name of the value to store.
	 * @param tag
	 *            The object to store with the measurement.
	 */
	public void tag(String key, Object tag);
}