Package com.tailf.progress

Class ProgressTraceNed

Object

com.tailf.progress.ProgressTrace

com.tailf.progress.ProgressTraceNed

public class ProgressTraceNed
extends ProgressTrace

The purpose of ProgressTraceNed class is to make it easy for a NED to interact with NSO's progress trace framework with the concept of spans.

An new event or span requires a device id and a device phase. The device id is set in the class constructor ProgressTraceNed(Maapi, String), and the device phase is set using setPhase(String) method. For example:

 ProgressTraceNed progress = new ProgressTraceNed(maapi, "mydev");
 progress.setPhase("connect");
 progress.event("connect");
 

See Also:

• ProgressTrace

Constructor Summary

Constructors

Constructor	Description
ProgressTraceNed(Maapi maapi, String deviceId)	Creates a new instance of ProgressTraceNed

Method Summary

Modifier and Type	Method	Description
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
void	setDeviceId(String deviceId)	Set a device ID
void	setPhase(String phase)	Set a NED phase
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 com.tailf.progress.ProgressTrace

endSpan, endSpan, getCurrentSpan, setServicePath

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressTraceNed

public ProgressTraceNed(Maapi maapi,
 String deviceId)
                 throws ConfException

Creates a new instance of ProgressTraceNed

Parameters:

maapi - a MAAPI instance

deviceId - device ID

Throws:

ConfException - is thrown if device Id is either null or empty

Method Details

setDeviceId

public void setDeviceId(String deviceId)

Set a device ID

Parameters:

deviceId - the device ID

setPhase

public void setPhase(String phase)

Set a NED phase

Parameters:

phase - the NED phase

event

public void event(String message)
           throws IOException,
ConfException

Report an event

Overrides:

event in class ProgressTrace

Parameters:

message - message to report

Throws:

IOException

ConfException

IOException

event

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

Report an event

Overrides:

event in class ProgressTrace

Parameters:

verbosity - at which verbosity level the message should be reported

message - message to report

Throws:

ConfException - is thrown if either device Id or device phase is not set.

IOException

event

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

Report an event

Overrides:

event in class ProgressTrace

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:

ConfException - is thrown if either device Id or device phase is not set.

IOException

startSpan

public Span startSpan(String message)
               throws IOException,
ConfException

Start a new span

Overrides:

startSpan in class ProgressTrace

Parameters:

message - message of the span

Returns:

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

Throws:

ConfException - is thrown if either device Id or device phase is not set.

IOException

startSpan

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

Start a new span

Overrides:

startSpan in class ProgressTrace

Parameters:

verbosity - at which verbosity level the message should be reported

message - message of the span

Returns:

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

Throws:

ConfException - is thrown if either device Id or device phase is not set.

IOException

startSpan

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

Start a new span

Overrides:

startSpan in class ProgressTrace

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 ProgressTrace.endSpan(com.tailf.progress.Span)

Throws:

ConfException - is thrown if either device Id or device phase is not set.

IOException