apmtraces

package
v46.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 31, 2021 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetSpanRequest 

type GetSpanRequest struct {

	// The APM Domain Id the request is intended for.
	ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`

	// Unique APM span identifier(spanId).
	SpanKey *string `mandatory:"true" contributesTo:"path" name:"spanKey"`

	// Unique APM trace identifier(traceId).
	TraceKey *string `mandatory:"true" contributesTo:"path" name:"traceKey"`

	// Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetSpanRequest wrapper for the GetSpan operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/GetSpan.go.html to see an example of how to use GetSpanRequest.

func (GetSpanRequest) BinaryRequestBody 

func (request GetSpanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSpanRequest) HTTPRequest 

func (request GetSpanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSpanRequest) RetryPolicy 

func (request GetSpanRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSpanRequest) String 

func (request GetSpanRequest) String() string

type GetSpanResponse 

type GetSpanResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Span instance
	Span `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetSpanResponse wrapper for the GetSpan operation

func (GetSpanResponse) HTTPResponse 

func (response GetSpanResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSpanResponse) String 

func (response GetSpanResponse) String() string

type GetTraceRequest 

type GetTraceRequest struct {

	// The APM Domain Id the request is intended for.
	ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`

	// Unique APM trace identifier(traceId).
	TraceKey *string `mandatory:"true" contributesTo:"path" name:"traceKey"`

	// Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetTraceRequest wrapper for the GetTrace operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/GetTrace.go.html to see an example of how to use GetTraceRequest.

func (GetTraceRequest) BinaryRequestBody 

func (request GetTraceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTraceRequest) HTTPRequest 

func (request GetTraceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTraceRequest) RetryPolicy 

func (request GetTraceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTraceRequest) String 

func (request GetTraceRequest) String() string

type GetTraceResponse 

type GetTraceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Trace instance
	Trace `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetTraceResponse wrapper for the GetTrace operation

func (GetTraceResponse) HTTPResponse 

func (response GetTraceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTraceResponse) String 

func (response GetTraceResponse) String() string

type ListQuickPicksRequest 

type ListQuickPicksRequest struct {

	// The APM Domain Id the request is intended for.
	ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`

	// Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results.
	// This is usually retrieved from a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListQuickPicksRequest wrapper for the ListQuickPicks operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/ListQuickPicks.go.html to see an example of how to use ListQuickPicksRequest.

func (ListQuickPicksRequest) BinaryRequestBody 

func (request ListQuickPicksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListQuickPicksRequest) HTTPRequest 

func (request ListQuickPicksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListQuickPicksRequest) RetryPolicy 

func (request ListQuickPicksRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListQuickPicksRequest) String 

func (request ListQuickPicksRequest) String() string

type ListQuickPicksResponse 

type ListQuickPicksResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []QuickPickSummary instances
	Items []QuickPickSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the page parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListQuickPicksResponse wrapper for the ListQuickPicks operation

func (ListQuickPicksResponse) HTTPResponse 

func (response ListQuickPicksResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListQuickPicksResponse) String 

func (response ListQuickPicksResponse) String() string

type QueryClient 

type QueryClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

QueryClient a client for Query

func NewQueryClientWithConfigurationProvider 

func NewQueryClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client QueryClient, err error)

NewQueryClientWithConfigurationProvider Creates a new default Query client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewQueryClientWithOboToken 

func NewQueryClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client QueryClient, err error)

NewQueryClientWithOboToken Creates a new default Query client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*QueryClient) ConfigurationProvider 

func (client *QueryClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (QueryClient) ListQuickPicks 

func (client QueryClient) ListQuickPicks(ctx context.Context, request ListQuickPicksRequest) (response ListQuickPicksResponse, err error)

ListQuickPicks Returns a list of predefined quick pick queries intended to assist the user to choose a query to run. There is no sorting applied on the results.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/ListQuickPicks.go.html to see an example of how to use ListQuickPicks API.

func (QueryClient) Query 

func (client QueryClient) Query(ctx context.Context, request QueryRequest) (response QueryResponse, err error)

Query Given a query, constructed according to the APM Defined Query Syntax, retrieves the results - selected attributes, and aggregations of the queried entity. Query Results are filtered by the filter criteria specified in the where clause. Further query results are grouped by the attributes specified in the group by clause. Finally, ordering (asc/desc) is done by the specified attributes in the order by clause.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/Query.go.html to see an example of how to use Query API.

func (QueryClient) QueryOld 

func (client QueryClient) QueryOld(ctx context.Context, request QueryOldRequest) (response QueryOldResponse, err error)

QueryOld THIS API ENDPOINT WILL BE DEPRECATED AND INSTEAD /queries/actions/runQuery as defined below WILL BE USED GOING FORWARD. THIS EXISTS JUST AS A TEMPORARY PLACEHOLDER SO AS TO BE BACKWARDS COMPATIBLE WITH THE UI BETWEEN RELEASE CYCLES. Given a query, constructed according to the APM Defined Query Syntax, retrieves the results - selected attributes, and aggregations of the queried entity. Query Results are filtered by the filter criteria specified in the where clause. Further query results are grouped by the attributes specified in the group by clause. Finally, ordering (asc/desc) is done by the specified attributes in the order by clause.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/QueryOld.go.html to see an example of how to use QueryOld API.

func (*QueryClient) SetRegion 

func (client *QueryClient) SetRegion(region string)

SetRegion overrides the region of this client.

type QueryDetails 

type QueryDetails struct {

	// APM defined query string to run against our repository and return results for.
	QueryText *string `mandatory:"false" json:"queryText"`
}

QueryDetails Request object containing the query to be run against our repository.

func (QueryDetails) String 

func (m QueryDetails) String() string

type QueryOldRequest 

type QueryOldRequest struct {

	// The APM Domain Id the request is intended for.
	ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`

	// Include spans that have a `spanStartTime` equal to or greater this value.
	TimeSpanStartedGreaterThanOrEqualTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeSpanStartedGreaterThanOrEqualTo"`

	// Include spans that have a `spanStartTime`less than this value.
	TimeSpanStartedLessThan *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeSpanStartedLessThan"`

	// Request body containing the query to be run against our repository.
	QueryDetails `contributesTo:"body"`

	// Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results.
	// This is usually retrieved from a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

QueryOldRequest wrapper for the QueryOld operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/QueryOld.go.html to see an example of how to use QueryOldRequest.

func (QueryOldRequest) BinaryRequestBody 

func (request QueryOldRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (QueryOldRequest) HTTPRequest 

func (request QueryOldRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (QueryOldRequest) RetryPolicy 

func (request QueryOldRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (QueryOldRequest) String 

func (request QueryOldRequest) String() string

type QueryOldResponse 

type QueryOldResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of QueryResultResponse instances
	QueryResultResponse `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the page parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

QueryOldResponse wrapper for the QueryOld operation

func (QueryOldResponse) HTTPResponse 

func (response QueryOldResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (QueryOldResponse) String 

func (response QueryOldResponse) String() string

type QueryRequest 

type QueryRequest struct {

	// The APM Domain Id the request is intended for.
	ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`

	// Include spans that have a `spanStartTime` equal to or greater this value.
	TimeSpanStartedGreaterThanOrEqualTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeSpanStartedGreaterThanOrEqualTo"`

	// Include spans that have a `spanStartTime`less than this value.
	TimeSpanStartedLessThan *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeSpanStartedLessThan"`

	// Request body containing the query to be run against our repository.
	QueryDetails `contributesTo:"body"`

	// Unique Oracle-assigned identifier for the request.  If you need to contact Oracle about a
	// particular request, please provide the request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results.
	// This is usually retrieved from a previous response.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

QueryRequest wrapper for the Query operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/Query.go.html to see an example of how to use QueryRequest.

func (QueryRequest) BinaryRequestBody 

func (request QueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (QueryRequest) HTTPRequest 

func (request QueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (QueryRequest) RetryPolicy 

func (request QueryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (QueryRequest) String 

func (request QueryRequest) String() string

type QueryResponse 

type QueryResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of QueryResultResponse instances
	QueryResultResponse `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`

	// For pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the page parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

QueryResponse wrapper for the Query operation

func (QueryResponse) HTTPResponse 

func (response QueryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (QueryResponse) String 

func (response QueryResponse) String() string

type QueryResultMetadataSummary 

type QueryResultMetadataSummary struct {

	// A collection of QueryResultRowTypeSummary objects that describe the type and properties of the individual row elements of the query rows
	// being returned.  The ith element in this list contains the QueryResultRowTypeSummary of the ith key value pair in the QueryResultRowData map.
	QueryResultRowTypeSummaries []QueryResultRowTypeSummary `mandatory:"false" json:"queryResultRowTypeSummaries"`

	// Source of the query result set (traces, spans, etc).
	SourceName *string `mandatory:"false" json:"sourceName"`

	// Columns or attributes of the query rows  which are group by values.  This is a list of ResultsGroupedBy summary objects,
	// and the list will contain as many elements as the attributes and aggregate functions in the group by clause in the select query.
	QueryResultsGroupedBy []QueryResultsGroupedBySummary `mandatory:"false" json:"queryResultsGroupedBy"`

	// Order by which the query results are organized.  This is a list of queryResultsOrderedBy summary objects, and the list
	// will contain more than one OrderedBy summary object, if the sort was multidimensional.
	QueryResultsOrderedBy []QueryResultsOrderedBySummary `mandatory:"false" json:"queryResultsOrderedBy"`

	// Interval for the time series function in minutes.
	TimeSeriesIntervalInMins *int `mandatory:"false" json:"timeSeriesIntervalInMins"`
}

QueryResultMetadataSummary Summary containing the metadata about the query result set.

func (QueryResultMetadataSummary) String 

func (m QueryResultMetadataSummary) String() string

type QueryResultResponse 

type QueryResultResponse struct {
	QueryResultMetadataSummary *QueryResultMetadataSummary `mandatory:"true" json:"queryResultMetadataSummary"`

	// A collection of objects with each object representing an individual row of the query result set.  The total number of objects
	// returned in this collection correspond to the total number of rows returned by the actual query that is run against
	// the queried entity.
	QueryResultRows []QueryResultRow `mandatory:"true" json:"queryResultRows"`
}

QueryResultResponse A response containing a collection of query rows (selected attributes and aggregations) filtered, grouped and sorted by the specified criteria from the query that is run, and the associated summary describing the corresponding query result metadata.

func (QueryResultResponse) String 

func (m QueryResultResponse) String() string

type QueryResultRow 

type QueryResultRow struct {

	// A map containing the actual data represented by a single row of the query result.
	// The key is the column name or attribute specified in the show clause, or an aggregate function in the show clause.
	// The value is the actual value of that attribute or aggregate function of the corresponding single row of the query result set.
	// If an alias name is specified for an attribute or an aggregate function, then the key will be the alias name specified in the show
	// clause.  If an alias name is not specified for the group by aggregate function in the show clause, then the corresponding key
	// will be the appropriate aggregate_function_name_column_name (Eg: count(traces) will be keyed as count_traces).  For more details
	// on the supported aggregate functions, look at the APM confluence doc on High Level Query Aggregation.  The datatype of the value
	// is presented in the queryResultRowTypeSummaries list in the queryResultMetadata structure, where the ith queryResultRowTypeSummary object
	// represents the datatype of the ith value when this map is iterated in order.
	QueryResultRowData map[string]interface{} `mandatory:"true" json:"queryResultRowData"`

	// A map containing metadata or add-on data for the data presented in the queryResultRowData map.  Data required to present drill down
	// information from the queryResultRowData is presented as key value pairs.
	QueryResultRowMetadata map[string]interface{} `mandatory:"true" json:"queryResultRowMetadata"`
}

QueryResultRow An object that represents a single row of the query result. It contains the queryResultRowData object that holds the actual data represented by the elements of the query result row, and a queryResultRowMetadata object that holds the metadata about the data contained in the query result row.

func (QueryResultRow) String 

func (m QueryResultRow) String() string

type QueryResultRowTypeSummary 

type QueryResultRowTypeSummary struct {

	// Datatype of the query result row element.
	DataType *string `mandatory:"false" json:"dataType"`

	// Granular unit in which the query result row element's data is represented.
	Unit *string `mandatory:"false" json:"unit"`

	// Alias name if an alias is used for the query result row element or an assigned display name from the query language
	// in some default cases.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Actual show expression in the user typed query that produced this column.
	Expression *string `mandatory:"false" json:"expression"`

	// A query result row type summary object that represents a nested table structure.
	QueryResultRowTypeSummaries []QueryResultRowTypeSummary `mandatory:"false" json:"queryResultRowTypeSummaries"`
}

QueryResultRowTypeSummary A summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.

func (QueryResultRowTypeSummary) String 

func (m QueryResultRowTypeSummary) String() string

type QueryResultsGroupedBySummary 

type QueryResultsGroupedBySummary struct {

	// Column or attribute in the query result which is a group by value.
	QueryResultsGroupedByColumn *string `mandatory:"false" json:"queryResultsGroupedByColumn"`
}

QueryResultsGroupedBySummary Summary of the attribute based on which the query results are grouped by.

func (QueryResultsGroupedBySummary) String 

func (m QueryResultsGroupedBySummary) String() string

type QueryResultsOrderedBySummary 

type QueryResultsOrderedBySummary struct {

	// Attribute by which the query result is sorted by.
	QueryResultsOrderedBy *string `mandatory:"false" json:"queryResultsOrderedBy"`

	// The sort order for the attribute, either 'ASC' or 'DESC'.
	QueryResultsSortOrder *string `mandatory:"false" json:"queryResultsSortOrder"`
}

QueryResultsOrderedBySummary Summary of the sort attribute and order by which the query results are organized.

func (QueryResultsOrderedBySummary) String 

func (m QueryResultsOrderedBySummary) String() string

type QuickPickSummary 

type QuickPickSummary struct {

	// Quick pick name for the query.
	QuickPickName *string `mandatory:"true" json:"quickPickName"`

	// Query for the quick pick.
	QuickPickQuery *string `mandatory:"true" json:"quickPickQuery"`
}

QuickPickSummary Summary of quick pick query objects that contains the quick pick queries.

func (QuickPickSummary) String 

func (m QuickPickSummary) String() string

type Span 

type Span struct {

	// Unique identifier (spanId) for the span.  Note that this field is
	// defined as spanKey in the API to comply with OCI API fields naming conventions.
	// The spanKey maps to the spanId in the APM repository.
	Key *string `mandatory:"true" json:"key"`

	// Unique identifier for the trace.
	TraceKey *string `mandatory:"true" json:"traceKey"`

	// Span start time.  Timestamp when the span was started.
	TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`

	// Span end time.  Timestamp when the span was completed.
	TimeEnded *common.SDKTime `mandatory:"true" json:"timeEnded"`

	// Total span duration in milliseconds.
	DurationInMs *int64 `mandatory:"true" json:"durationInMs"`

	// Span name associated with the trace.  This is usually the method or uri of the request.
	OperationName *string `mandatory:"true" json:"operationName"`

	// Indicates if the span has an error
	IsError *bool `mandatory:"true" json:"isError"`

	// Unique parent identifier for the span if one exists. For root spans this will be null.
	ParentSpanKey *string `mandatory:"false" json:"parentSpanKey"`

	// Service name associated with the span.
	ServiceName *string `mandatory:"false" json:"serviceName"`

	// Kind associated with the span.
	Kind *string `mandatory:"false" json:"kind"`

	// List of tags associated with the span.
	Tags []Tag `mandatory:"false" json:"tags"`

	// List of logs associated with the span.
	Logs []SpanLogCollection `mandatory:"false" json:"logs"`
}

Span Definition of a span object.

func (Span) String 

func (m Span) String() string

type SpanLog 

type SpanLog struct {

	// Key that specifies the log name.
	LogKey *string `mandatory:"true" json:"logKey"`

	// Value associated with the log key.
	LogValue *string `mandatory:"true" json:"logValue"`
}

SpanLog Definition of a log which is a key value pair of log data.

func (SpanLog) String 

func (m SpanLog) String() string

type SpanLogCollection 

type SpanLogCollection struct {

	// Timestamp at which the log is created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// List of logs associated with the span at the given timestamp.
	SpanLogs []SpanLog `mandatory:"false" json:"spanLogs"`
}

SpanLogCollection Definition of span log collection object.

func (SpanLogCollection) String 

func (m SpanLogCollection) String() string

type Tag 

type Tag struct {

	// Key that specifies the tag name.
	TagName *string `mandatory:"true" json:"tagName"`

	// Value associated with the tag key.
	TagValue *string `mandatory:"true" json:"tagValue"`
}

Tag Definition of a tag which is a key value pair.

func (Tag) String 

func (m Tag) String() string

type Trace 

type Trace struct {

	// Unique identifier (traceId) for the trace that represents the span set.  Note that this field is
	// defined as traceKey in the API to comply with OCI API fields naming conventions.  The traceKey maps to
	// the traceId in the APM repository.
	Key *string `mandatory:"true" json:"key"`

	// An array of spans in the trace.
	Spans []Span `mandatory:"true" json:"spans"`

	// Root span name associated with the trace. This is usually the flow start operation name.
	// Null if the root span is not yet completed.
	RootSpanOperationName *string `mandatory:"false" json:"rootSpanOperationName"`

	// Start time of the earliest span in this span collection.
	TimeEarliestSpanStarted *common.SDKTime `mandatory:"false" json:"timeEarliestSpanStarted"`

	// End time of the span that most recently ended in this span collection.
	TimeLatestSpanEnded *common.SDKTime `mandatory:"false" json:"timeLatestSpanEnded"`

	// The number of spans that have been processed by the system for this trace.  Note that there
	// could be additional spans that have not been processed or reported yet if the trace is still
	// in progress.
	SpanCount *int `mandatory:"false" json:"spanCount"`

	// The number of spans with error that have been processed by the system for this trace.
	// Note that the number of spans with errors may be less than the total number of actual spans
	// in this trace.
	ErrorSpanCount *int `mandatory:"false" json:"errorSpanCount"`

	// Service associated with this trace.
	RootSpanServiceName *string `mandatory:"false" json:"rootSpanServiceName"`

	// Start time of the root span for this span collection.
	TimeRootSpanStarted *common.SDKTime `mandatory:"false" json:"timeRootSpanStarted"`

	// End time of the root span for this span collection.
	TimeRootSpanEnded *common.SDKTime `mandatory:"false" json:"timeRootSpanEnded"`

	// Time taken for the root span operation to complete in milliseconds.
	RootSpanDurationInMs *int `mandatory:"false" json:"rootSpanDurationInMs"`

	// Time between the start of the earliest span and the end of the most recent span in milliseconds.
	TraceDurationInMs *int `mandatory:"false" json:"traceDurationInMs"`

	// Boolean flag that indicates whether the trace errored out.
	IsFault *bool `mandatory:"false" json:"isFault"`

	// 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.
	TraceStatus *string `mandatory:"false" json:"traceStatus"`

	// Error type of the trace.
	TraceErrorType *string `mandatory:"false" json:"traceErrorType"`

	// Error code of the trace.
	TraceErrorCode *string `mandatory:"false" json:"traceErrorCode"`

	// A summary of the spans by service
	ServiceSummaries []TraceServiceSummary `mandatory:"false" json:"serviceSummaries"`

	SpanSummary *TraceSpanSummary `mandatory:"false" json:"spanSummary"`
}

Trace Definition of a trace object.

func (Trace) String 

func (m Trace) String() string

type TraceClient 

type TraceClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

TraceClient a client for Trace

func NewTraceClientWithConfigurationProvider 

func NewTraceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client TraceClient, err error)

NewTraceClientWithConfigurationProvider Creates a new default Trace client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewTraceClientWithOboToken 

func NewTraceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client TraceClient, err error)

NewTraceClientWithOboToken Creates a new default Trace client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*TraceClient) ConfigurationProvider 

func (client *TraceClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (TraceClient) GetSpan 

func (client TraceClient) GetSpan(ctx context.Context, request GetSpanRequest) (response GetSpanResponse, err error)

GetSpan Get the span details identified by spanId

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/GetSpan.go.html to see an example of how to use GetSpan API.

func (TraceClient) GetTrace 

func (client TraceClient) GetTrace(ctx context.Context, request GetTraceRequest) (response GetTraceResponse, err error)

GetTrace Get the trace details identified by traceId

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apmtraces/GetTrace.go.html to see an example of how to use GetTrace API.

func (*TraceClient) SetRegion 

func (client *TraceClient) SetRegion(region string)

SetRegion overrides the region of this client.

type TraceServiceSummary 

type TraceServiceSummary struct {

	// Name associated with the service.
	SpanServiceName *string `mandatory:"true" json:"spanServiceName"`

	// Number of spans for serviceName in this trace.
	TotalSpans *int64 `mandatory:"true" json:"totalSpans"`

	// Number of spans with errorsfor serviceName in this trace.
	ErrorSpans *int64 `mandatory:"true" json:"errorSpans"`
}

TraceServiceSummary A summary of the spans in a trace by service.

func (TraceServiceSummary) String 

func (m TraceServiceSummary) String() string

type TraceSpanSummary 

type TraceSpanSummary struct {

	// Unique identifier (traceId) for the trace that represents the span set.  Note that this field is
	// defined as traceKey in the API to comply with OCI API fields naming conventions.  The traceKey maps to
	// the traceId in the APM repository.
	Key *string `mandatory:"true" json:"key"`

	// Start time of the earliest span in this span collection.
	TimeEarliestSpanStarted *common.SDKTime `mandatory:"true" json:"timeEarliestSpanStarted"`

	// End time of the span that most recently ended in this span collection.
	TimeLatestSpanEnded *common.SDKTime `mandatory:"true" json:"timeLatestSpanEnded"`

	// The number of spans that have been processed by the system for this trace.  Note that there
	// could be additional spans that have not been processed or reported yet if the trace is still
	// in progress.
	SpanCount *int `mandatory:"true" json:"spanCount"`

	// The number of spans with error that have been processed by the system for this trace.
	// Note that the number of spans with errors may be less than the total number of actual spans
	// in this trace.
	ErrorSpanCount *int `mandatory:"true" json:"errorSpanCount"`

	// Time between the start of the earliest span and the end of the most recent span in milliseconds.
	TraceDurationInMs *int `mandatory:"true" json:"traceDurationInMs"`

	// Boolean flag that indicates whether the trace errored out.
	IsFault *bool `mandatory:"true" json:"isFault"`

	// 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.
	TraceStatus *string `mandatory:"true" json:"traceStatus"`

	// Error type of the trace.
	TraceErrorType *string `mandatory:"true" json:"traceErrorType"`

	// Error code of the trace.
	TraceErrorCode *string `mandatory:"true" json:"traceErrorCode"`

	// Root span name associated with the trace. This is usually the flow start operation name.
	// Null if the root span is not yet completed.
	RootSpanOperationName *string `mandatory:"false" json:"rootSpanOperationName"`

	// Service associated with this trace.
	RootSpanServiceName *string `mandatory:"false" json:"rootSpanServiceName"`

	// Start time of the root span for this span collection.
	TimeRootSpanStarted *common.SDKTime `mandatory:"false" json:"timeRootSpanStarted"`

	// End time of the root span for this span collection.
	TimeRootSpanEnded *common.SDKTime `mandatory:"false" json:"timeRootSpanEnded"`

	// Time taken for the root span operation to complete in milliseconds.
	RootSpanDurationInMs *int `mandatory:"false" json:"rootSpanDurationInMs"`

	// A summary of the spans by service
	ServiceSummaries []TraceServiceSummary `mandatory:"false" json:"serviceSummaries"`
}

TraceSpanSummary Trace Span summary object is the summary of the span information for the spans in the span collection in the trace window that is being queried.

func (TraceSpanSummary) String 

func (m TraceSpanSummary) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.