AWSXRayRecorderImpl Class |
This class provides utilities to build an instance of AWSXRayRecorder with different configurations.
Inheritance HierarchyNamespace: Amazon.XRay.Recorder.Core
Assembly: AWSXRayRecorder.Core (in AWSXRayRecorder.Core.dll) Version: 2.14.0+018bfa65877dd72e346735bad4d7ad46f217da09
SyntaxC#
public abstract class AWSXRayRecorderImpl : IAWSXRayRecorder, IDisposable
The AWSXRayRecorderImpl type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AWSXRayRecorderImpl | Initializes a new instance of the AWSXRayRecorderImpl class |
Properties| Name | Description | |
|---|---|---|
 | ContextMissingStrategy |
Gets or sets the context missing strategy.
|
| ExceptionSerializationStrategy |
Defines exception serialization stategy to process recorded exceptions. ExceptionSerializationStrategy |
| Origin |
Gets or sets the origin of the service.
|
| RuntimeContext |
Gets the runtime context which is generated by plugins.
|
| SamplingStrategy |
Gets or sets the sampling strategy.
|
| StreamingStrategy |
Instance of IStreamingStrategy, used to define the streaming strategy for segment/subsegment.
|
| TraceContext |
Instance of ITraceContext, used to store segment/subsegment.
|
Methods| Name | Description | |
|---|---|---|
 | AddAnnotation | |
| AddException |
Add the exception to current segment and also mark current segment as fault.
|
| AddHttpInformation |
Adds the specified key and value as http information to current segment.
|
| AddMetadata(String, Object) |
Adds the specified key and value to metadata under default namespace.
|
| AddMetadata(String, String, Object) |
Adds the specified key and value to metadata with given namespace.
|
| AddPrecursorId |
Add a precursor id.
|
| AddSqlInformation |
Add the specified key and value as SQL information to current segment.
|
| BeginSegment |
Begin a tracing segment. A new tracing segment will be created and started.
|
| BeginSubsegment |
Begin a tracing subsegment. A new subsegment will be created and added as a subsegment to previous segment.
|
| BeginSubsegmentWithoutSampling |
Begin a tracing subsegment. A new subsegment will be created and added as a subsegment to previous segment.
|
| ClearEntity |
Clear entity from TraceContext.
|
| Dispose |
Free resources within the object.
|
| Dispose(Boolean) |
Free resources within the object.
|
| EndSegment |
End tracing of a given segment.
|
| EndSubsegment |
End a subsegment.
|
| GetEntity |
Gets entity (segment/subsegment) from the TraceContext.
|
| HandleEntityNotAvailableException |
If entity is not available in the TraceContext, exception is thrown.
|
| IsEntityPresent |
Checks whether entity is present in TraceContext.
|
| IsTracingDisabled |
Checks whether Tracing is enabled or disabled.
|
| MarkError |
Mark the current segment as error.
|
| MarkFault |
Mark the current segment as fault.
|
| MarkThrottle |
Mark the current segment as being throttled. And Error will also be marked for current segment.
|
| SetDaemonAddress |
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.
|
| SetEntity |
Set the specified entity (segment/subsegment) into TraceContext.
|
| SetExceptionSerializationStrategy |
Configures recorder with ExceptionSerializationStrategy. While setting number consider max trace size
limit : https://aws.amazon.com/xray/pricing/
|
| SetNamespace |
Set namespace to current segment.
|
| SetTraceContext |
Configures recorder instance with ITraceContext.
|
| TraceMethod(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.
|
| TraceMethodTResult(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.
|
| TraceMethodAsync(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.
|
| TraceMethodAsyncTResult(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.
|
See Also