Class TraceClient
Service client instance for Trace.
Implements
Inherited Members
Namespace: Oci.ApmtracesService
Assembly: OCI.DotNetSDK.Apmtraces.dll
Syntax
public class TraceClient : RegionalClientBase, IDisposable
Constructors
TraceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public TraceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Methods
GetAggregatedSnapshot(GetAggregatedSnapshotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the aggregated snapshot identified by trace ID.
Declaration
public Task<GetAggregatedSnapshotResponse> GetAggregatedSnapshot(GetAggregatedSnapshotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAggregatedSnapshotRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAggregatedSnapshotResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAggregatedSnapshot API.
GetSpan(GetSpanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the span details identified by spanId.
Declaration
public Task<GetSpanResponse> GetSpan(GetSpanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSpanRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSpanResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSpan API.
GetTrace(GetTraceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the trace details identified by traceId.
Declaration
public Task<GetTraceResponse> GetTrace(GetTraceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTraceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTraceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTrace API.
GetTraceSnapshot(GetTraceSnapshotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the trace snapshots data identified by trace ID.
Declaration
public Task<GetTraceSnapshotResponse> GetTraceSnapshot(GetTraceSnapshotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTraceSnapshotRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTraceSnapshotResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTraceSnapshot API.