Click or drag to resize

AWSXRayRecorderImpl Class

This class provides utilities to build an instance of AWSXRayRecorder with different configurations.
Inheritance Hierarchy

Namespace:  Amazon.XRay.Recorder.Core
Assembly:  AWSXRayRecorder.Core (in AWSXRayRecorder.Core.dll) Version: 2.5.2
Syntax
C#
public abstract class AWSXRayRecorderImpl : IAWSXRayRecorder, 
	IDisposable

The AWSXRayRecorderImpl type exposes the following members.

Constructors
  NameDescription
Protected methodAWSXRayRecorderImpl
Initializes a new instance of the AWSXRayRecorderImpl class
Top
Properties
  NameDescription
Public propertyContextMissingStrategy
Gets or sets the context missing strategy.
Public propertyExceptionSerializationStrategy
Defines exception serialization stategy to process recorded exceptions. ExceptionSerializationStrategy
Public propertyOrigin
Gets or sets the origin of the service.
Public propertyRuntimeContext
Gets the runtime context which is generated by plugins.
Public propertySamplingStrategy
Gets or sets the sampling strategy.
Public propertyTraceContext
Instance of ITraceContext, used to store segment/subsegment.
Top
Methods
  NameDescription
Public methodAddAnnotation
Adds the specified key and value as annotation to current segment. The type of value is restricted. Only String, Int32, Int64, Double and Boolean are supported.
Public methodAddException
Add the exception to current segment and also mark current segment as fault.
Public methodAddHttpInformation
Adds the specified key and value as http information to current segment.
Public methodAddMetadata(String, Object)
Adds the specified key and value to metadata under default namespace.
Public methodAddMetadata(String, String, Object)
Adds the specified key and value to metadata with given namespace.
Public methodAddPrecursorId
Add a precursor id.
Public methodAddSqlInformation
Add the specified key and value as SQL information to current segment.
Public methodBeginSegment
Begin a tracing segment. A new tracing segment will be created and started.
Public methodBeginSubsegment
Begin a tracing subsegment. A new segment will be created and added as a subsegment to previous segment.
Public methodClearEntity
Clear entity from TraceContext.
Public methodDispose
Free resources within the object.
Protected methodDispose(Boolean)
Free resources within the object.
Public methodEndSegment
End tracing of a given segment.
Public methodEndSubsegment
End a subsegment.
Public methodGetEntity
Gets entity (segment/subsegment) from the TraceContext.
Protected methodHandleEntityNotAvailableException
If entity is not available in the TraceContext, exception is thrown.
Public methodIsEntityPresent
Checks whether entity is present in TraceContext.
Public methodIsTracingDisabled
Checks whether Tracing is enabled or disabled.
Public methodMarkError
Mark the current segment as error.
Public methodMarkFault
Mark the current segment as fault.
Public methodMarkThrottle
Mark the current segment as being throttled. And Error will also be marked for current segment.
Public methodSetDaemonAddress
Sets the daemon address for Emitter and DefaultSamplingStrategy if set. A notation of '127.0.0.1:2000' or 'tcp:127.0.0.1:2000 udp:127.0.0.2:2001' or 'udp:127.0.0.1:2000 tcp:127.0.0.2:2001' are acceptable.The former one means UDP and TCP are running at the same address. If environment variable is set to specific daemon address, the call to this method will be ignored.
Public methodSetEntity
Set the specified entity (segment/subsegment) into TraceContext.
Public methodSetExceptionSerializationStrategy
Configures recorder with ExceptionSerializationStrategy. While setting number consider max trace size limit : https://aws.amazon.com/xray/pricing/
Public methodSetNamespace
Set namespace to current segment.
Public methodSetTraceContext
Configures recorder instance with ITraceContext.
Public methodTraceMethod(String, Action)
Trace a given method returns void. A subsegment will be created for this method. Any exception thrown by the method will be captured.
Public methodTraceMethodTResult(String, FuncTResult)
Trace a given function with return value. A subsegment will be created for this method. Any exception thrown by the method will be captured.
Public methodTraceMethodAsync(String, FuncTask)
Trace a given asynchronous method that returns no value. A subsegment will be created for this method. Any exception thrown by the method will be captured.
Public methodTraceMethodAsyncTResult(String, FuncTaskTResult)
Trace a given asynchronous function with return value. A subsegment will be created for this method. Any exception thrown by the method will be captured.
Top
See Also