Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.ApmTraces.getTrace

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testTrace = oci.ApmTraces.getTrace({
    apmDomainId: testApmDomain.id,
    traceKey: traceTraceKey,
    timeTraceStartedGreaterThanOrEqualTo: traceTimeTraceStartedGreaterThanOrEqualTo,
    timeTraceStartedLessThan: traceTimeTraceStartedLessThan,
    traceNamespace: traceTraceNamespace,
});

import pulumi
import pulumi_oci as oci

test_trace = oci.ApmTraces.get_trace(apm_domain_id=test_apm_domain["id"],
    trace_key=trace_trace_key,
    time_trace_started_greater_than_or_equal_to=trace_time_trace_started_greater_than_or_equal_to,
    time_trace_started_less_than=trace_time_trace_started_less_than,
    trace_namespace=trace_trace_namespace)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apmtraces"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apmtraces.GetTrace(ctx, &apmtraces.GetTraceArgs{
			ApmDomainId:                          testApmDomain.Id,
			TraceKey:                             traceTraceKey,
			TimeTraceStartedGreaterThanOrEqualTo: pulumi.StringRef(traceTimeTraceStartedGreaterThanOrEqualTo),
			TimeTraceStartedLessThan:             pulumi.StringRef(traceTimeTraceStartedLessThan),
			TraceNamespace:                       pulumi.StringRef(traceTraceNamespace),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testTrace = Oci.ApmTraces.GetTrace.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        TraceKey = traceTraceKey,
        TimeTraceStartedGreaterThanOrEqualTo = traceTimeTraceStartedGreaterThanOrEqualTo,
        TimeTraceStartedLessThan = traceTimeTraceStartedLessThan,
        TraceNamespace = traceTraceNamespace,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApmTraces.ApmTracesFunctions;
import com.pulumi.oci.ApmTraces.inputs.GetTraceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testTrace = ApmTracesFunctions.getTrace(GetTraceArgs.builder()
            .apmDomainId(testApmDomain.id())
            .traceKey(traceTraceKey)
            .timeTraceStartedGreaterThanOrEqualTo(traceTimeTraceStartedGreaterThanOrEqualTo)
            .timeTraceStartedLessThan(traceTimeTraceStartedLessThan)
            .traceNamespace(traceTraceNamespace)
            .build());

    }
}

variables:
  testTrace:
    fn::invoke:
      function: oci:ApmTraces:getTrace
      arguments:
        apmDomainId: ${testApmDomain.id}
        traceKey: ${traceTraceKey}
        timeTraceStartedGreaterThanOrEqualTo: ${traceTimeTraceStartedGreaterThanOrEqualTo}
        timeTraceStartedLessThan: ${traceTimeTraceStartedLessThan}
        traceNamespace: ${traceTraceNamespace}

Using getTrace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getTrace(args: GetTraceArgs, opts?: InvokeOptions): Promise<GetTraceResult>
function getTraceOutput(args: GetTraceOutputArgs, opts?: InvokeOptions): Output<GetTraceResult>

def get_trace(apm_domain_id: Optional[str] = None,
              time_trace_started_greater_than_or_equal_to: Optional[str] = None,
              time_trace_started_less_than: Optional[str] = None,
              trace_key: Optional[str] = None,
              trace_namespace: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTraceResult
def get_trace_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
              time_trace_started_greater_than_or_equal_to: Optional[pulumi.Input[str]] = None,
              time_trace_started_less_than: Optional[pulumi.Input[str]] = None,
              trace_key: Optional[pulumi.Input[str]] = None,
              trace_namespace: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTraceResult]

func GetTrace(ctx *Context, args *GetTraceArgs, opts ...InvokeOption) (*GetTraceResult, error)
func GetTraceOutput(ctx *Context, args *GetTraceOutputArgs, opts ...InvokeOption) GetTraceResultOutput

> Note: This function is named GetTrace in the Go SDK.

public static class GetTrace 
{
    public static Task<GetTraceResult> InvokeAsync(GetTraceArgs args, InvokeOptions? opts = null)
    public static Output<GetTraceResult> Invoke(GetTraceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTraceResult> getTrace(GetTraceArgs args, InvokeOptions options)
public static Output<GetTraceResult> getTrace(GetTraceArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ApmTraces/getTrace:getTrace
  arguments:
    # arguments dictionary

The following arguments are supported:

ApmDomainId string: The APM Domain ID for the intended request.
TraceKey string: Unique Application Performance Monitoring trace identifier (traceId).
TimeTraceStartedGreaterThanOrEqualTo string: Include traces that have a minTraceStartTime equal to or greater than this value.
TimeTraceStartedLessThan string: Include traces that have a minTraceStartTime less than this value.
TraceNamespace string: Name space from which the trace details need to be retrieved.

ApmDomainId string: The APM Domain ID for the intended request.
TraceKey string: Unique Application Performance Monitoring trace identifier (traceId).
TimeTraceStartedGreaterThanOrEqualTo string: Include traces that have a minTraceStartTime equal to or greater than this value.
TimeTraceStartedLessThan string: Include traces that have a minTraceStartTime less than this value.
TraceNamespace string: Name space from which the trace details need to be retrieved.

apmDomainId String: The APM Domain ID for the intended request.
traceKey String: Unique Application Performance Monitoring trace identifier (traceId).
timeTraceStartedGreaterThanOrEqualTo String: Include traces that have a minTraceStartTime equal to or greater than this value.
timeTraceStartedLessThan String: Include traces that have a minTraceStartTime less than this value.
traceNamespace String: Name space from which the trace details need to be retrieved.

apmDomainId string: The APM Domain ID for the intended request.
traceKey string: Unique Application Performance Monitoring trace identifier (traceId).
timeTraceStartedGreaterThanOrEqualTo string: Include traces that have a minTraceStartTime equal to or greater than this value.
timeTraceStartedLessThan string: Include traces that have a minTraceStartTime less than this value.
traceNamespace string: Name space from which the trace details need to be retrieved.

apm_domain_id str: The APM Domain ID for the intended request.
trace_key str: Unique Application Performance Monitoring trace identifier (traceId).
time_trace_started_greater_than_or_equal_to str: Include traces that have a minTraceStartTime equal to or greater than this value.
time_trace_started_less_than str: Include traces that have a minTraceStartTime less than this value.
trace_namespace str: Name space from which the trace details need to be retrieved.

apmDomainId String: The APM Domain ID for the intended request.
traceKey String: Unique Application Performance Monitoring trace identifier (traceId).
timeTraceStartedGreaterThanOrEqualTo String: Include traces that have a minTraceStartTime equal to or greater than this value.
timeTraceStartedLessThan String: Include traces that have a minTraceStartTime less than this value.
traceNamespace String: Name space from which the trace details need to be retrieved.

getTrace Result

The following output properties are available:

ApmDomainId string
ErrorSpanCount int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
Id string: The provider-assigned unique ID for this managed resource.
IsFault bool: Boolean flag that indicates whether the trace has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
RootSpanDurationInMs int: Time taken for the root span operation to complete in milliseconds.
RootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
RootSpanServiceName string: Service associated with the trace.
ServiceSummaries List<GetTraceServiceSummary>: A summary of the spans by service.
SourceName string: Source of span (spans, syn_spans).
SpanCount int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
SpanSummaries List<GetTraceSpanSummary>: Summary of the information pertaining to the spans in the trace window that is being queried.
Spans List<GetTraceSpan>: An array of spans in the trace.
TimeEarliestSpanStarted string: Start time of the earliest span in the span collection.
TimeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
TimeRootSpanEnded string: End time of the root span for the span collection.
TimeRootSpanStarted string: Start time of the root span for the span collection.
TraceDurationInMs int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
TraceErrorCode string: Error code of the trace.
TraceErrorType string: Error type of the trace.
TraceKey string: Unique identifier for the trace.
TraceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
TimeTraceStartedGreaterThanOrEqualTo string
TimeTraceStartedLessThan string
TraceNamespace string

ApmDomainId string
ErrorSpanCount int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
Id string: The provider-assigned unique ID for this managed resource.
IsFault bool: Boolean flag that indicates whether the trace has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
RootSpanDurationInMs int: Time taken for the root span operation to complete in milliseconds.
RootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
RootSpanServiceName string: Service associated with the trace.
ServiceSummaries []GetTraceServiceSummary: A summary of the spans by service.
SourceName string: Source of span (spans, syn_spans).
SpanCount int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
SpanSummaries []GetTraceSpanSummary: Summary of the information pertaining to the spans in the trace window that is being queried.
Spans []GetTraceSpan: An array of spans in the trace.
TimeEarliestSpanStarted string: Start time of the earliest span in the span collection.
TimeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
TimeRootSpanEnded string: End time of the root span for the span collection.
TimeRootSpanStarted string: Start time of the root span for the span collection.
TraceDurationInMs int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
TraceErrorCode string: Error code of the trace.
TraceErrorType string: Error type of the trace.
TraceKey string: Unique identifier for the trace.
TraceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
TimeTraceStartedGreaterThanOrEqualTo string
TimeTraceStartedLessThan string
TraceNamespace string

apmDomainId String
errorSpanCount Integer: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
id String: The provider-assigned unique ID for this managed resource.
isFault Boolean: Boolean flag that indicates whether the trace has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs Integer: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName String: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName String: Service associated with the trace.
serviceSummaries List<GetTraceServiceSummary>: A summary of the spans by service.
sourceName String: Source of span (spans, syn_spans).
spanCount Integer: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
spanSummaries List<GetTraceSpanSummary>: Summary of the information pertaining to the spans in the trace window that is being queried.
spans List<GetTraceSpan>: An array of spans in the trace.
timeEarliestSpanStarted String: Start time of the earliest span in the span collection.
timeLatestSpanEnded String: End time of the span that most recently ended in the span collection.
timeRootSpanEnded String: End time of the root span for the span collection.
timeRootSpanStarted String: Start time of the root span for the span collection.
traceDurationInMs Integer: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode String: Error code of the trace.
traceErrorType String: Error type of the trace.
traceKey String: Unique identifier for the trace.
traceStatus String: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
timeTraceStartedGreaterThanOrEqualTo String
timeTraceStartedLessThan String
traceNamespace String

apmDomainId string
errorSpanCount number: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
id string: The provider-assigned unique ID for this managed resource.
isFault boolean: Boolean flag that indicates whether the trace has an error.
key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs number: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName string: Service associated with the trace.
serviceSummaries GetTraceServiceSummary[]: A summary of the spans by service.
sourceName string: Source of span (spans, syn_spans).
spanCount number: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
spanSummaries GetTraceSpanSummary[]: Summary of the information pertaining to the spans in the trace window that is being queried.
spans GetTraceSpan[]: An array of spans in the trace.
timeEarliestSpanStarted string: Start time of the earliest span in the span collection.
timeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
timeRootSpanEnded string: End time of the root span for the span collection.
timeRootSpanStarted string: Start time of the root span for the span collection.
traceDurationInMs number: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode string: Error code of the trace.
traceErrorType string: Error type of the trace.
traceKey string: Unique identifier for the trace.
traceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
timeTraceStartedGreaterThanOrEqualTo string
timeTraceStartedLessThan string
traceNamespace string

apm_domain_id str
error_span_count int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
id str: The provider-assigned unique ID for this managed resource.
is_fault bool: Boolean flag that indicates whether the trace has an error.
key str: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
root_span_duration_in_ms int: Time taken for the root span operation to complete in milliseconds.
root_span_operation_name str: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
root_span_service_name str: Service associated with the trace.
service_summaries Sequence[apmtraces.GetTraceServiceSummary]: A summary of the spans by service.
source_name str: Source of span (spans, syn_spans).
span_count int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
span_summaries Sequence[apmtraces.GetTraceSpanSummary]: Summary of the information pertaining to the spans in the trace window that is being queried.
spans Sequence[apmtraces.GetTraceSpan]: An array of spans in the trace.
time_earliest_span_started str: Start time of the earliest span in the span collection.
time_latest_span_ended str: End time of the span that most recently ended in the span collection.
time_root_span_ended str: End time of the root span for the span collection.
time_root_span_started str: Start time of the root span for the span collection.
trace_duration_in_ms int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
trace_error_code str: Error code of the trace.
trace_error_type str: Error type of the trace.
trace_key str: Unique identifier for the trace.
trace_status str: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
time_trace_started_greater_than_or_equal_to str
time_trace_started_less_than str
trace_namespace str

apmDomainId String
errorSpanCount Number: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
id String: The provider-assigned unique ID for this managed resource.
isFault Boolean: Boolean flag that indicates whether the trace has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs Number: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName String: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName String: Service associated with the trace.
serviceSummaries List<Property Map>: A summary of the spans by service.
sourceName String: Source of span (spans, syn_spans).
spanCount Number: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
spanSummaries List<Property Map>: Summary of the information pertaining to the spans in the trace window that is being queried.
spans List<Property Map>: An array of spans in the trace.
timeEarliestSpanStarted String: Start time of the earliest span in the span collection.
timeLatestSpanEnded String: End time of the span that most recently ended in the span collection.
timeRootSpanEnded String: End time of the root span for the span collection.
timeRootSpanStarted String: Start time of the root span for the span collection.
traceDurationInMs Number: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode String: Error code of the trace.
traceErrorType String: Error type of the trace.
traceKey String: Unique identifier for the trace.
traceStatus String: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.
timeTraceStartedGreaterThanOrEqualTo String
timeTraceStartedLessThan String
traceNamespace String

Supporting Types

GetTraceServiceSummary

ErrorSpans string: Number of spans with errors for serviceName in the trace.
SpanServiceName string: Name associated with the service.
TotalSpans string: Number of spans for serviceName in the trace.

ErrorSpans string: Number of spans with errors for serviceName in the trace.
SpanServiceName string: Name associated with the service.
TotalSpans string: Number of spans for serviceName in the trace.

errorSpans String: Number of spans with errors for serviceName in the trace.
spanServiceName String: Name associated with the service.
totalSpans String: Number of spans for serviceName in the trace.

errorSpans string: Number of spans with errors for serviceName in the trace.
spanServiceName string: Name associated with the service.
totalSpans string: Number of spans for serviceName in the trace.

error_spans str: Number of spans with errors for serviceName in the trace.
span_service_name str: Name associated with the service.
total_spans str: Number of spans for serviceName in the trace.

errorSpans String: Number of spans with errors for serviceName in the trace.
spanServiceName String: Name associated with the service.
totalSpans String: Number of spans for serviceName in the trace.

GetTraceSpan

DurationInMs string: Total span duration in milliseconds.
IsError bool: Indicates if the span has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
Kind string: Kind associated with the span.
Logs List<GetTraceSpanLog>: List of logs associated with the span.
OperationName string: Span name associated with the trace. This is usually the method or URI of the request.
ParentSpanKey string: Unique parent identifier for the span if one exists. For root spans this will be null.
ServiceName string: Service name associated with the span.
SourceName string: Source of span (spans, syn_spans).
Tags List<GetTraceSpanTag>: List of tags associated with the span.
TimeEnded string: Span end time. Timestamp when the span was completed.
TimeStarted string: Span start time. Timestamp when the span was started.
TraceKey string: Unique Application Performance Monitoring trace identifier (traceId).

DurationInMs string: Total span duration in milliseconds.
IsError bool: Indicates if the span has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
Kind string: Kind associated with the span.
Logs []GetTraceSpanLog: List of logs associated with the span.
OperationName string: Span name associated with the trace. This is usually the method or URI of the request.
ParentSpanKey string: Unique parent identifier for the span if one exists. For root spans this will be null.
ServiceName string: Service name associated with the span.
SourceName string: Source of span (spans, syn_spans).
Tags []GetTraceSpanTag: List of tags associated with the span.
TimeEnded string: Span end time. Timestamp when the span was completed.
TimeStarted string: Span start time. Timestamp when the span was started.
TraceKey string: Unique Application Performance Monitoring trace identifier (traceId).

durationInMs String: Total span duration in milliseconds.
isError Boolean: Indicates if the span has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
kind String: Kind associated with the span.
logs List<GetTraceSpanLog>: List of logs associated with the span.
operationName String: Span name associated with the trace. This is usually the method or URI of the request.
parentSpanKey String: Unique parent identifier for the span if one exists. For root spans this will be null.
serviceName String: Service name associated with the span.
sourceName String: Source of span (spans, syn_spans).
tags List<GetTraceSpanTag>: List of tags associated with the span.
timeEnded String: Span end time. Timestamp when the span was completed.
timeStarted String: Span start time. Timestamp when the span was started.
traceKey String: Unique Application Performance Monitoring trace identifier (traceId).

durationInMs string: Total span duration in milliseconds.
isError boolean: Indicates if the span has an error.
key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
kind string: Kind associated with the span.
logs GetTraceSpanLog[]: List of logs associated with the span.
operationName string: Span name associated with the trace. This is usually the method or URI of the request.
parentSpanKey string: Unique parent identifier for the span if one exists. For root spans this will be null.
serviceName string: Service name associated with the span.
sourceName string: Source of span (spans, syn_spans).
tags GetTraceSpanTag[]: List of tags associated with the span.
timeEnded string: Span end time. Timestamp when the span was completed.
timeStarted string: Span start time. Timestamp when the span was started.
traceKey string: Unique Application Performance Monitoring trace identifier (traceId).

duration_in_ms str: Total span duration in milliseconds.
is_error bool: Indicates if the span has an error.
key str: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
kind str: Kind associated with the span.
logs Sequence[apmtraces.GetTraceSpanLog]: List of logs associated with the span.
operation_name str: Span name associated with the trace. This is usually the method or URI of the request.
parent_span_key str: Unique parent identifier for the span if one exists. For root spans this will be null.
service_name str: Service name associated with the span.
source_name str: Source of span (spans, syn_spans).
tags Sequence[apmtraces.GetTraceSpanTag]: List of tags associated with the span.
time_ended str: Span end time. Timestamp when the span was completed.
time_started str: Span start time. Timestamp when the span was started.
trace_key str: Unique Application Performance Monitoring trace identifier (traceId).

durationInMs String: Total span duration in milliseconds.
isError Boolean: Indicates if the span has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
kind String: Kind associated with the span.
logs List<Property Map>: List of logs associated with the span.
operationName String: Span name associated with the trace. This is usually the method or URI of the request.
parentSpanKey String: Unique parent identifier for the span if one exists. For root spans this will be null.
serviceName String: Service name associated with the span.
sourceName String: Source of span (spans, syn_spans).
tags List<Property Map>: List of tags associated with the span.
timeEnded String: Span end time. Timestamp when the span was completed.
timeStarted String: Span start time. Timestamp when the span was started.
traceKey String: Unique Application Performance Monitoring trace identifier (traceId).

GetTraceSpanLog

EventName string: Name of the event for which the log is created.
SpanLogs List<GetTraceSpanLogSpanLog>: List of logs associated with the span at the given timestamp.
TimeCreated string: Timestamp at which the log is created.

EventName string: Name of the event for which the log is created.
SpanLogs []GetTraceSpanLogSpanLog: List of logs associated with the span at the given timestamp.
TimeCreated string: Timestamp at which the log is created.

eventName String: Name of the event for which the log is created.
spanLogs List<GetTraceSpanLogSpanLog>: List of logs associated with the span at the given timestamp.
timeCreated String: Timestamp at which the log is created.

eventName string: Name of the event for which the log is created.
spanLogs GetTraceSpanLogSpanLog[]: List of logs associated with the span at the given timestamp.
timeCreated string: Timestamp at which the log is created.

event_name str: Name of the event for which the log is created.
span_logs Sequence[apmtraces.GetTraceSpanLogSpanLog]: List of logs associated with the span at the given timestamp.
time_created str: Timestamp at which the log is created.

eventName String: Name of the event for which the log is created.
spanLogs List<Property Map>: List of logs associated with the span at the given timestamp.
timeCreated String: Timestamp at which the log is created.

GetTraceSpanLogSpanLog

LogKey string: Key that specifies the log name.
LogValue string: Value associated with the log key.

LogKey string: Key that specifies the log name.
LogValue string: Value associated with the log key.

logKey String: Key that specifies the log name.
logValue String: Value associated with the log key.

logKey string: Key that specifies the log name.
logValue string: Value associated with the log key.

log_key str: Key that specifies the log name.
log_value str: Value associated with the log key.

logKey String: Key that specifies the log name.
logValue String: Value associated with the log key.

GetTraceSpanSummary

ErrorSpanCount int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
IsFault bool: Boolean flag that indicates whether the trace has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
RootSpanDurationInMs int: Time taken for the root span operation to complete in milliseconds.
RootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
RootSpanServiceName string: Service associated with the trace.
ServiceSummaries List<GetTraceSpanSummaryServiceSummary>: A summary of the spans by service.
SpanCount int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
TimeEarliestSpanStarted string: Start time of the earliest span in the span collection.
TimeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
TimeRootSpanEnded string: End time of the root span for the span collection.
TimeRootSpanStarted string: Start time of the root span for the span collection.
TraceDurationInMs int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
TraceErrorCode string: Error code of the trace.
TraceErrorType string: Error type of the trace.
TraceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

ErrorSpanCount int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
IsFault bool: Boolean flag that indicates whether the trace has an error.
Key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
RootSpanDurationInMs int: Time taken for the root span operation to complete in milliseconds.
RootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
RootSpanServiceName string: Service associated with the trace.
ServiceSummaries []GetTraceSpanSummaryServiceSummary: A summary of the spans by service.
SpanCount int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
TimeEarliestSpanStarted string: Start time of the earliest span in the span collection.
TimeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
TimeRootSpanEnded string: End time of the root span for the span collection.
TimeRootSpanStarted string: Start time of the root span for the span collection.
TraceDurationInMs int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
TraceErrorCode string: Error code of the trace.
TraceErrorType string: Error type of the trace.
TraceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

errorSpanCount Integer: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
isFault Boolean: Boolean flag that indicates whether the trace has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs Integer: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName String: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName String: Service associated with the trace.
serviceSummaries List<GetTraceSpanSummaryServiceSummary>: A summary of the spans by service.
spanCount Integer: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
timeEarliestSpanStarted String: Start time of the earliest span in the span collection.
timeLatestSpanEnded String: End time of the span that most recently ended in the span collection.
timeRootSpanEnded String: End time of the root span for the span collection.
timeRootSpanStarted String: Start time of the root span for the span collection.
traceDurationInMs Integer: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode String: Error code of the trace.
traceErrorType String: Error type of the trace.
traceStatus String: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

errorSpanCount number: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
isFault boolean: Boolean flag that indicates whether the trace has an error.
key string: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs number: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName string: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName string: Service associated with the trace.
serviceSummaries GetTraceSpanSummaryServiceSummary[]: A summary of the spans by service.
spanCount number: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
timeEarliestSpanStarted string: Start time of the earliest span in the span collection.
timeLatestSpanEnded string: End time of the span that most recently ended in the span collection.
timeRootSpanEnded string: End time of the root span for the span collection.
timeRootSpanStarted string: Start time of the root span for the span collection.
traceDurationInMs number: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode string: Error code of the trace.
traceErrorType string: Error type of the trace.
traceStatus string: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

error_span_count int: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
is_fault bool: Boolean flag that indicates whether the trace has an error.
key str: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
root_span_duration_in_ms int: Time taken for the root span operation to complete in milliseconds.
root_span_operation_name str: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
root_span_service_name str: Service associated with the trace.
service_summaries Sequence[apmtraces.GetTraceSpanSummaryServiceSummary]: A summary of the spans by service.
span_count int: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
time_earliest_span_started str: Start time of the earliest span in the span collection.
time_latest_span_ended str: End time of the span that most recently ended in the span collection.
time_root_span_ended str: End time of the root span for the span collection.
time_root_span_started str: Start time of the root span for the span collection.
trace_duration_in_ms int: Time between the start of the earliest span and the end of the most recent span in milliseconds.
trace_error_code str: Error code of the trace.
trace_error_type str: Error type of the trace.
trace_status str: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

errorSpanCount Number: The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.
isFault Boolean: Boolean flag that indicates whether the trace has an error.
key String: Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.
rootSpanDurationInMs Number: Time taken for the root span operation to complete in milliseconds.
rootSpanOperationName String: Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.
rootSpanServiceName String: Service associated with the trace.
serviceSummaries List<Property Map>: A summary of the spans by service.
spanCount Number: The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.
timeEarliestSpanStarted String: Start time of the earliest span in the span collection.
timeLatestSpanEnded String: End time of the span that most recently ended in the span collection.
timeRootSpanEnded String: End time of the root span for the span collection.
timeRootSpanStarted String: Start time of the root span for the span collection.
traceDurationInMs Number: Time between the start of the earliest span and the end of the most recent span in milliseconds.
traceErrorCode String: Error code of the trace.
traceErrorType String: Error type of the trace.
traceStatus String: The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

GetTraceSpanSummaryServiceSummary

ErrorSpans string: Number of spans with errors for serviceName in the trace.
SpanServiceName string: Name associated with the service.
TotalSpans string: Number of spans for serviceName in the trace.

ErrorSpans string: Number of spans with errors for serviceName in the trace.
SpanServiceName string: Name associated with the service.
TotalSpans string: Number of spans for serviceName in the trace.

errorSpans String: Number of spans with errors for serviceName in the trace.
spanServiceName String: Name associated with the service.
totalSpans String: Number of spans for serviceName in the trace.

errorSpans string: Number of spans with errors for serviceName in the trace.
spanServiceName string: Name associated with the service.
totalSpans string: Number of spans for serviceName in the trace.

error_spans str: Number of spans with errors for serviceName in the trace.
span_service_name str: Name associated with the service.
total_spans str: Number of spans for serviceName in the trace.

errorSpans String: Number of spans with errors for serviceName in the trace.
spanServiceName String: Name associated with the service.
totalSpans String: Number of spans for serviceName in the trace.

GetTraceSpanTag

TagName string: Key that specifies the tag name.
TagValue string: Value associated with the tag key.

TagName string: Key that specifies the tag name.
TagValue string: Value associated with the tag key.

tagName String: Key that specifies the tag name.
tagValue String: Value associated with the tag key.

tagName string: Key that specifies the tag name.
tagValue string: Value associated with the tag key.

tag_name str: Key that specifies the tag name.
tag_value str: Value associated with the tag key.

tagName String: Key that specifies the tag name.
tagValue String: Value associated with the tag key.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.ApmTraces.getTrace

On this page

On this page

Example Usage

Using getTrace

getTrace Result

Supporting Types

GetTraceServiceSummary

GetTraceSpan

GetTraceSpanLog

GetTraceSpanLogSpanLog

GetTraceSpanSummary

GetTraceSpanSummaryServiceSummary

GetTraceSpanTag

Package Details

On this page

On this page