\TracesApi

All URIs are relative to http://localhost

Method	HTTP request	Description
GetSpan	Get /traces/{traceId}/spans/{spanId}	Get a span
GetTrace	Get /traces/{traceId}	Fetch a trace
QueryDuration	Post /traces/duration/histogram	Query duration distribution
QueryTraces	Post /traces/query	Query for traces
SpanComponents	Post /traces/components	Fetch components based on resource attributes
SuggestionsAttributeName	Get /traces/spans/fields/attributes	Suggestions for attribute names
SuggestionsAttributeValue	Get /traces/spans/fields/attributes/{attributeName}/values	Suggestions for attribute values
SuggestionsFieldValues	Get /traces/spans/fields/{field}/values	Suggestions for span fields

GetSpan

Span GetSpan(ctx, traceId, spanId).Execute()

Get a span

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    traceId := "traceId_example" // string | The id of the trace
    spanId := "spanId_example" // string | The id of the span

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.GetSpan(context.Background(), traceId, spanId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.GetSpan``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSpan`: Span
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.GetSpan`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
traceId	string	The id of the trace
spanId	string	The id of the span

Other Parameters

Other parameters are passed through a pointer to a apiGetSpanRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Span

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTrace

Trace GetTrace(ctx, traceId).Execute()

Fetch a trace

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    traceId := "traceId_example" // string | The id of the trace

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.GetTrace(context.Background(), traceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.GetTrace``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTrace`: Trace
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.GetTrace`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
traceId	string	The id of the trace

Other Parameters

Other parameters are passed through a pointer to a apiGetTraceRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Trace

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

QueryDuration

DurationHistogram QueryDuration(ctx).Start(start).End(end).BucketsCount(bucketsCount).TraceFilter(traceFilter).Execute()

Query duration distribution

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    start := int32(1707117737) // int32 | Filter spans by start time >= value
    end := int32(1707121359) // int32 | Filter spans by start time < value
    bucketsCount := int32(56) // int32 | The number of histogram buckets.
    traceFilter := *openapiclient.NewTraceFilter(*openapiclient.NewSpanFilter(), map[string][]string{"key": []string{"Inner_example"}}) // TraceFilter | Filter for traces

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.QueryDuration(context.Background()).Start(start).End(end).BucketsCount(bucketsCount).TraceFilter(traceFilter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.QueryDuration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `QueryDuration`: DurationHistogram
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.QueryDuration`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiQueryDurationRequest struct via the builder pattern

Name	Type	Description
start	int32	Filter spans by start time >= value
end	int32	Filter spans by start time < value
bucketsCount	int32	The number of histogram buckets.
traceFilter	TraceFilter	Filter for traces

Return type

DurationHistogram

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

QueryTraces

Traces QueryTraces(ctx).Start(start).End(end).TraceQuery(traceQuery).PageSize(pageSize).Page(page).Execute()

Query for traces

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    start := int32(1707117737) // int32 | Filter spans by start time >= value
    end := int32(1707121359) // int32 | Filter spans by start time < value
    traceQuery := *openapiclient.NewTraceQuery(*openapiclient.NewSpanFilter(), map[string][]string{"key": []string{"Inner_example"}}) // TraceQuery | Query for traces
    pageSize := int32(30) // int32 | Number of spans in 1 page (optional) (default to 20)
    page := int32(4) // int32 | Get the specified page (with pageSize # of spans), defaults to page 0 (optional) (default to 0)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.QueryTraces(context.Background()).Start(start).End(end).TraceQuery(traceQuery).PageSize(pageSize).Page(page).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.QueryTraces``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `QueryTraces`: Traces
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.QueryTraces`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiQueryTracesRequest struct via the builder pattern

Name	Type	Description	Notes
start	int32	Filter spans by start time >= value
end	int32	Filter spans by start time < value
traceQuery	TraceQuery	Query for traces
pageSize	int32	Number of spans in 1 page	[default to 20]
page	int32	Get the specified page (with pageSize # of spans), defaults to page 0	[default to 0]

Return type

Traces

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SpanComponents

SpanComponents SpanComponents(ctx).ComponentQuery(componentQuery).Execute()

Fetch components based on resource attributes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    componentQuery := *openapiclient.NewComponentQuery(map[string]string{"key": "Inner_example"}) // ComponentQuery | Span properties to find matching components

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.SpanComponents(context.Background()).ComponentQuery(componentQuery).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.SpanComponents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SpanComponents`: SpanComponents
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.SpanComponents`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSpanComponentsRequest struct via the builder pattern

Name	Type	Description	Notes
componentQuery	ComponentQuery	Span properties to find matching components

Return type

SpanComponents

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SuggestionsAttributeName

Suggestions SuggestionsAttributeName(ctx).Contains(contains).Execute()

Suggestions for attribute names

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    contains := "contains_example" // string | Get suggestions based of this partial name (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.SuggestionsAttributeName(context.Background()).Contains(contains).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.SuggestionsAttributeName``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SuggestionsAttributeName`: Suggestions
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.SuggestionsAttributeName`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSuggestionsAttributeNameRequest struct via the builder pattern

Name	Type	Description	Notes
contains	string	Get suggestions based of this partial name

Return type

Suggestions

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SuggestionsAttributeValue

Suggestions SuggestionsAttributeValue(ctx, attributeName).Contains(contains).Execute()

Suggestions for attribute values

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    attributeName := "attributeName_example" // string | Get suggestions for this attribute
    contains := "contains_example" // string | Get suggestions based on this partial value (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.SuggestionsAttributeValue(context.Background(), attributeName).Contains(contains).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.SuggestionsAttributeValue``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SuggestionsAttributeValue`: Suggestions
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.SuggestionsAttributeValue`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
attributeName	string	Get suggestions for this attribute

Other Parameters

Other parameters are passed through a pointer to a apiSuggestionsAttributeValueRequest struct via the builder pattern

Name	Type	Description	Notes

contains | string | Get suggestions based on this partial value |

Return type

Suggestions

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SuggestionsFieldValues

Suggestions SuggestionsFieldValues(ctx, field).Contains(contains).Execute()

Suggestions for span fields

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    field := openapiclient.SpanSuggestionField("ServiceName") // SpanSuggestionField | Get suggestions for this field
    contains := "contains_example" // string | Get suggestions for this field based on this partial value (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TracesApi.SuggestionsFieldValues(context.Background(), field).Contains(contains).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TracesApi.SuggestionsFieldValues``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SuggestionsFieldValues`: Suggestions
    fmt.Fprintf(os.Stdout, "Response from `TracesApi.SuggestionsFieldValues`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
field	SpanSuggestionField	Get suggestions for this field

Other Parameters

Other parameters are passed through a pointer to a apiSuggestionsFieldValuesRequest struct via the builder pattern

Name	Type	Description	Notes

contains | string | Get suggestions for this field based on this partial value |

Return type

Suggestions

Authorization

ApiToken, ServiceBearer, ServiceToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

TracesApi.md

Latest commit

History

TracesApi.md

File metadata and controls

\TracesApi

GetSpan

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTrace

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

QueryDuration

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

QueryTraces

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SpanComponents

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SuggestionsAttributeName

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SuggestionsAttributeValue

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SuggestionsFieldValues

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers