Package com.tailf.progress

Class ProgressTrace

Object

com.tailf.progress.ProgressTrace

Direct Known Subclasses:

ProgressTraceNed

public class ProgressTrace
extends Object

ProgressTrace class interacts with ConfD/NCS's progress trace framework over underlying MAAPI. See the Progress Trace chapter in the NSO Development Guide or in the ConfD User Guide for more information. The class is implemented based on the concept of spans. For example:

 ProgressTrace progress = new ProgressTrace(maapi, tid);
 Attributes attributes = new Attributes();
 attributes.set("name", "value");
 Span span1 = progress.startSpan(Maapi.Verbosity.VERY_VERBOSE,
                                 "span1",
                                 attributes,
                                 null);
 Span span2 = progress.startSpan("span2");
 progress.endSpan(span2);
 progress.endSpan(span1);
 

Constructor Summary

Constructors

Constructor	Description
ProgressTrace(Maapi maapi, int tid)	Creates a new instance of ProgressTrace
ProgressTrace(Maapi maapi, int tid, ConfPath servicePath)	Creates a new instance of ProgressTrace.

Method Summary

Modifier and Type	Method	Description
void	endSpan(Span span)	End a span
void	endSpan(Span span, String annotation)	End a span with annotation
void	event(Maapi.Verbosity verbosity, String message)	Report an event
void	event(Maapi.Verbosity verbosity, String message, Attributes attributes)	Report an event
void	event(String message)	Report an event
Span	getCurrentSpan()	Get the current span that is created by this API.
void	setServicePath(ConfPath servicePath)	Set NSO's service path
Span	startSpan(Maapi.Verbosity verbosity, String message)	Start a new span
Span	startSpan(Maapi.Verbosity verbosity, String message, Attributes attributes, Span[] links)	Start a new span
Span	startSpan(String message)	Start a new span

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProgressTrace

public ProgressTrace(Maapi maapi,
 int tid)
              throws ConfException

Creates a new instance of ProgressTrace

Parameters:

maapi - a MAAPI instance

tid - transaction ID

Throws:

ConfException

ProgressTrace

public ProgressTrace(Maapi maapi,
 int tid,
 ConfPath servicePath)

Creates a new instance of ProgressTrace. It is used for NSO service.

Parameters:

maapi - a MAAPI instance

tid - transaction ID

servicePath - path of an NSO service instance

Method Details

getCurrentSpan

public Span getCurrentSpan()

Get the current span that is created by this API. The current span is updated to a new span or previous span depending on when a startSpan(java.lang.String) or a endSpan(com.tailf.progress.Span) is called.

Returns:

a Span object or EmptySpan object if the span is not created by the API.

setServicePath

public void setServicePath(ConfPath servicePath)

Set NSO's service path

Parameters:

servicePath - the service path

event

public void event(String message)
           throws IOException,
ConfException

Report an event

Parameters:

message - message to report

Throws:

IOException

ConfException

event

public void event(Maapi.Verbosity verbosity,
 String message)
           throws IOException,
ConfException

Report an event

Parameters:

verbosity - at which verbosity level the message should be reported

message - message to report

Throws:

IOException

ConfException

event

public void event(Maapi.Verbosity verbosity,
 String message,
 Attributes attributes)
           throws IOException,
ConfException

Report an event

Parameters:

verbosity - at which verbosity level the message should be reported

message - message to report

attributes - attributes of the events. This can be null.

Throws:

IOException

ConfException

startSpan

public Span startSpan(String message)
               throws IOException,
ConfException

Start a new span

Parameters:

message - message of the span

Returns:

a Span object that is used for endSpan(com.tailf.progress.Span)

Throws:

IOException

ConfException

startSpan

public Span startSpan(Maapi.Verbosity verbosity,
 String message)
               throws IOException,
ConfException

Start a new span

Parameters:

verbosity - at which verbosity level the message should be reported

message - message of the span

Returns:

a Span object that can used in endSpan(com.tailf.progress.Span)

Throws:

IOException

ConfException

startSpan

public Span startSpan(Maapi.Verbosity verbosity,
 String message,
 Attributes attributes,
 Span[] links)
               throws IOException,
ConfException

Start a new span

Parameters:

verbosity - at which verbosity level the message should be reported

message - message of the span

attributes - attributes of the span This can be null.

links - list of linked spans This can be null.

Returns:

a Span object that can used in endSpan(com.tailf.progress.Span)

Throws:

IOException

ConfException

endSpan

public void endSpan(Span span)
             throws IOException,
ConfException

End a span

Parameters:

span - the span which was previously started

Throws:

IOException

ConfException

endSpan

public void endSpan(Span span,
 String annotation)
             throws IOException,
ConfException

End a span with annotation

Parameters:

span - the span which was previously started

annotation - an annotation for this ending span This can be null

Throws:

IOException

ConfException