AggregatedSnapshot Aggregated snapshots of all spans.
type AggregatedSnapshot struct {
// Aggregated snapshot details.
Details []SnapshotDetail `mandatory:"true" json:"details"`
// List of aggregated stack trace.
AggregatedStackTraces []AggregatedStackTrace `mandatory:"true" json:"aggregatedStackTraces"`
}
func (m AggregatedSnapshot) String() string
func (m AggregatedSnapshot) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AggregatedStackTrace A branching tree with aggregated stack trace.
type AggregatedStackTrace struct {
StackTraceElement *StackTraceElement `mandatory:"false" json:"stackTraceElement"`
// List of child aggregated stack trace to represent branches.
Children []AggregatedStackTrace `mandatory:"false" json:"children"`
}
func (m AggregatedStackTrace) String() string
func (m AggregatedStackTrace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAggregatedSnapshotRequest wrapper for the GetAggregatedSnapshot operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetAggregatedSnapshot.go.html to see an example of how to use GetAggregatedSnapshotRequest.
type GetAggregatedSnapshotRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique Application Performance Monitoring 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
}
func (request GetAggregatedSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAggregatedSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAggregatedSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAggregatedSnapshotRequest) String() string
func (request GetAggregatedSnapshotRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetAggregatedSnapshotResponse wrapper for the GetAggregatedSnapshot operation
type GetAggregatedSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The AggregatedSnapshot instance
AggregatedSnapshot `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"`
}
func (response GetAggregatedSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAggregatedSnapshotResponse) String() string
GetSpanRequest wrapper for the GetSpan operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetSpan.go.html to see an example of how to use GetSpanRequest.
type GetSpanRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique Application Performance Monitoring span identifier (spanId).
SpanKey *string `mandatory:"true" contributesTo:"path" name:"spanKey"`
// Unique Application Performance Monitoring 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
}
func (request GetSpanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSpanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSpanRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSpanRequest) String() string
func (request GetSpanRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSpanResponse wrapper for the GetSpan operation
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"`
}
func (response GetSpanResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSpanResponse) String() string
GetTraceRequest wrapper for the GetTrace operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetTrace.go.html to see an example of how to use GetTraceRequest.
type GetTraceRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique Application Performance Monitoring 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
}
func (request GetTraceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTraceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTraceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTraceRequest) String() string
func (request GetTraceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTraceResponse wrapper for the GetTrace operation
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"`
}
func (response GetTraceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTraceResponse) String() string
GetTraceSnapshotRequest wrapper for the GetTraceSnapshot operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetTraceSnapshot.go.html to see an example of how to use GetTraceSnapshotRequest.
type GetTraceSnapshotRequest struct {
// The APM Domain ID the request is intended for.
ApmDomainId *string `mandatory:"true" contributesTo:"query" name:"apmDomainId"`
// Unique Application Performance Monitoring 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"`
// If enabled, then only span level details will be sent.
IsSummarized *bool `mandatory:"false" contributesTo:"query" name:"isSummarized"`
// Thread id for which snapshots needs to be retrieved. This is an identifier of a thread, and is a positive long number generated when when a thread is created.
ThreadId *string `mandatory:"false" contributesTo:"query" name:"threadId"`
// Epoch time of snapshot.
SnapshotTime *string `mandatory:"false" contributesTo:"query" name:"snapshotTime"`
// 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
}
func (request GetTraceSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTraceSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTraceSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTraceSnapshotRequest) String() string
func (request GetTraceSnapshotRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetTraceSnapshotResponse wrapper for the GetTraceSnapshot operation
type GetTraceSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The TraceSnapshot instance
TraceSnapshot `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"`
}
func (response GetTraceSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTraceSnapshotResponse) String() string
ListQuickPicksRequest wrapper for the ListQuickPicks operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/ListQuickPicks.go.html to see an example of how to use 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
}
func (request ListQuickPicksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListQuickPicksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListQuickPicksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListQuickPicksRequest) String() string
func (request ListQuickPicksRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListQuickPicksResponse wrapper for the ListQuickPicks operation
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"`
}
func (response ListQuickPicksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListQuickPicksResponse) String() string
QueryClient a client for Query
type QueryClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *QueryClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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/65.54.0/apmtraces/ListQuickPicks.go.html to see an example of how to use ListQuickPicks API.
func (client QueryClient) Query(ctx context.Context, request QueryRequest) (response QueryResponse, err error)
Query Retrieves the results (selected attributes and aggregations) of a query constructed according to the Application Performance Monitoring Defined Query Syntax. 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/65.54.0/apmtraces/Query.go.html to see an example of how to use Query API.
func (client *QueryClient) SetRegion(region string)
SetRegion overrides the region of this client.
QueryDetails Request object containing the query to be run against the trace data.
type QueryDetails struct {
// Application Performance Monitoring defined query string that filters and retrieves trace data results.
QueryText *string `mandatory:"false" json:"queryText"`
}
func (m QueryDetails) String() string
func (m QueryDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryRequest wrapper for the Query operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/Query.go.html to see an example of how to use 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 than 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 the trace data and to filter and
// retrieve trace data results.
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
}
func (request QueryRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request QueryRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request QueryRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request QueryRequest) String() string
func (request QueryRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryResponse wrapper for the Query operation
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"`
}
func (response QueryResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response QueryResponse) String() string
QueryResultMetadataSummary Summary containing the metadata about the query result set.
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 i-th element in this list contains the QueryResultRowTypeSummary of the i-th key-value pair in the QueryResultRowData map.
QueryResultRowTypeSummaries []QueryResultRowTypeSummary `mandatory:"false" json:"queryResultRowTypeSummaries"`
// Source of the query result set (traces, spans, and so on).
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"`
}
func (m QueryResultMetadataSummary) String() string
func (m QueryResultMetadataSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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.
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"`
}
func (m QueryResultResponse) String() string
func (m QueryResultResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryResultRow Object that represents a single row of the query result. It contains the queryResultRowData object that contains the actual data represented by the elements of the query result row, and a queryResultRowMetadata object that contains the metadata about the data contained in the query result row.
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 (For example: count(traces) will be keyed as count_traces). The datatype of the value
// is presented in the queryResultRowTypeSummaries list in the queryResultMetadata structure, where the i-th queryResultRowTypeSummary object
// represents the datatype of the i-th 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"`
}
func (m QueryResultRow) String() string
func (m QueryResultRow) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryResultRowTypeSummary Summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.
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"`
}
func (m QueryResultRowTypeSummary) String() string
func (m QueryResultRowTypeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryResultsGroupedBySummary Summary of the attribute based on which the query results are grouped.
type QueryResultsGroupedBySummary struct {
// Column or attribute in the query result, which is a group by value.
QueryResultsGroupedByColumn *string `mandatory:"false" json:"queryResultsGroupedByColumn"`
}
func (m QueryResultsGroupedBySummary) String() string
func (m QueryResultsGroupedBySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryResultsOrderedBySummary Summary of the sort and order by attribute based on which the query results are organized.
type QueryResultsOrderedBySummary struct {
// Attribute by which the query results are sorted.
QueryResultsOrderedBy *string `mandatory:"false" json:"queryResultsOrderedBy"`
// The sort order for the attribute, either 'ASC' or 'DESC'.
QueryResultsSortOrder *string `mandatory:"false" json:"queryResultsSortOrder"`
}
func (m QueryResultsOrderedBySummary) String() string
func (m QueryResultsOrderedBySummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QuickPickSummary Summary of the Quick Pick query objects.
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"`
}
func (m QuickPickSummary) String() string
func (m QuickPickSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SnapshotDetail A generic key value pair object, which contains information such as the thread ID, thread name, and thread state.
type SnapshotDetail struct {
// Name of the property.
Key *string `mandatory:"false" json:"key"`
// Value of the property.
Value *interface{} `mandatory:"false" json:"value"`
}
func (m SnapshotDetail) String() string
func (m SnapshotDetail) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Span Definition of a span object.
type Span struct {
// 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.
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"`
}
func (m Span) String() string
func (m Span) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SpanLog Definition of a log which is a key-value pair of log data.
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"`
}
func (m SpanLog) String() string
func (m SpanLog) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SpanLogCollection Definition of span log collection object.
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"`
}
func (m SpanLogCollection) String() string
func (m SpanLogCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SpanSnapshot Definition of a span snapshot object.
type SpanSnapshot struct {
// Unique identifier (spanId) for the trace span.
Key *string `mandatory:"true" json:"key"`
// Start time of the span.
TimeStarted *common.SDKTime `mandatory:"true" json:"timeStarted"`
// End time of the span.
TimeEnded *common.SDKTime `mandatory:"true" json:"timeEnded"`
// Span name associated with the trace.
SpanName *string `mandatory:"false" json:"spanName"`
// Span snapshots properties.
SpanSnapshotDetails []SnapshotDetail `mandatory:"false" json:"spanSnapshotDetails"`
// Thread snapshots.
ThreadSnapshots []ThreadSnapshot `mandatory:"false" json:"threadSnapshots"`
// An array of child span snapshots.
Children []SpanSnapshot `mandatory:"false" json:"children"`
}
func (m SpanSnapshot) String() string
func (m SpanSnapshot) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StackTraceElement Stack trace element.
type StackTraceElement struct {
// Name of the method containing the execution point.
MethodName *string `mandatory:"false" json:"methodName"`
// Name of the source file containing the execution point.
FileName *string `mandatory:"false" json:"fileName"`
// Line number of the source line containing the execution point.
LineNumber *int `mandatory:"false" json:"lineNumber"`
// Name of the class containing the execution point.
ClassName *string `mandatory:"false" json:"className"`
// The weight distribution that denotes the percentage occurrence of a method in the captured snapshots.
Weightage *float32 `mandatory:"false" json:"weightage"`
}
func (m StackTraceElement) String() string
func (m StackTraceElement) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Tag Definition of a tag which is a key-value pair.
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"`
}
func (m Tag) String() string
func (m Tag) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ThreadSnapshot Thread snapshot.
type ThreadSnapshot struct {
// Snapshot time.
TimeStamp *common.SDKTime `mandatory:"false" json:"timeStamp"`
// Snapshot details.
ThreadSnapshotDetails []SnapshotDetail `mandatory:"false" json:"threadSnapshotDetails"`
// Stack trace.
StackTrace []StackTraceElement `mandatory:"false" json:"stackTrace"`
}
func (m ThreadSnapshot) String() string
func (m ThreadSnapshot) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Trace Definition of a trace object.
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 and it maps to the traceId in the trace data in Application Performance
// Monitoring.
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 the flow start operation name.
// Null is displayed if the root span is not yet completed.
RootSpanOperationName *string `mandatory:"false" json:"rootSpanOperationName"`
// Start time of the earliest span in the span collection.
TimeEarliestSpanStarted *common.SDKTime `mandatory:"false" json:"timeEarliestSpanStarted"`
// End time of the span that most recently ended in the span collection.
TimeLatestSpanEnded *common.SDKTime `mandatory:"false" json:"timeLatestSpanEnded"`
// 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.
SpanCount *int `mandatory:"false" json:"spanCount"`
// 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.
ErrorSpanCount *int `mandatory:"false" json:"errorSpanCount"`
// Service associated with the trace.
RootSpanServiceName *string `mandatory:"false" json:"rootSpanServiceName"`
// Start time of the root span for the span collection.
TimeRootSpanStarted *common.SDKTime `mandatory:"false" json:"timeRootSpanStarted"`
// End time of the root span for the 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 has an error.
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"`
}
func (m Trace) String() string
func (m Trace) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TraceClient a client for Trace
type TraceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *TraceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client TraceClient) GetAggregatedSnapshot(ctx context.Context, request GetAggregatedSnapshotRequest) (response GetAggregatedSnapshotResponse, err error)
GetAggregatedSnapshot Gets the aggregated snapshot identified by trace ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetAggregatedSnapshot.go.html to see an example of how to use GetAggregatedSnapshot API.
func (client TraceClient) GetSpan(ctx context.Context, request GetSpanRequest) (response GetSpanResponse, err error)
GetSpan Gets the span details identified by spanId.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetSpan.go.html to see an example of how to use GetSpan API.
func (client TraceClient) GetTrace(ctx context.Context, request GetTraceRequest) (response GetTraceResponse, err error)
GetTrace Gets the trace details identified by traceId.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetTrace.go.html to see an example of how to use GetTrace API.
func (client TraceClient) GetTraceSnapshot(ctx context.Context, request GetTraceSnapshotRequest) (response GetTraceSnapshotResponse, err error)
GetTraceSnapshot Gets the trace snapshots data identified by trace ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/apmtraces/GetTraceSnapshot.go.html to see an example of how to use GetTraceSnapshot API.
func (client *TraceClient) SetRegion(region string)
SetRegion overrides the region of this client.
TraceServiceSummary Summary of the spans in a trace by service.
type TraceServiceSummary struct {
// Name associated with the service.
SpanServiceName *string `mandatory:"true" json:"spanServiceName"`
// Number of spans for serviceName in the trace.
TotalSpans *int64 `mandatory:"true" json:"totalSpans"`
// Number of spans with errors for serviceName in the trace.
ErrorSpans *int64 `mandatory:"true" json:"errorSpans"`
}
func (m TraceServiceSummary) String() string
func (m TraceServiceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TraceSnapshot Definition of a trace snapshot object.
type TraceSnapshot struct {
// Unique identifier (traceId) for the trace that represents the span set. Note that this field is
// defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance
// Monitoring.
Key *string `mandatory:"true" json:"key"`
// List of spans.
SpanSnapshots []SpanSnapshot `mandatory:"true" json:"spanSnapshots"`
// Start time of the trace.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// End time of the trace.
TimeEnded *common.SDKTime `mandatory:"false" json:"timeEnded"`
// Trace snapshots properties.
TraceSnapshotDetails []SnapshotDetail `mandatory:"false" json:"traceSnapshotDetails"`
}
func (m TraceSnapshot) String() string
func (m TraceSnapshot) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TraceSpanSummary Summary of the information pertaining to the spans in the trace window that is being queried.
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 and it maps to the traceId in the trace data in Application Performance
// Monitoring.
Key *string `mandatory:"true" json:"key"`
// Start time of the earliest span in the span collection.
TimeEarliestSpanStarted *common.SDKTime `mandatory:"true" json:"timeEarliestSpanStarted"`
// End time of the span that most recently ended in the span collection.
TimeLatestSpanEnded *common.SDKTime `mandatory:"true" json:"timeLatestSpanEnded"`
// 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.
SpanCount *int `mandatory:"true" json:"spanCount"`
// 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.
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 has an error.
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 the flow start operation name.
// Null is displayed if the root span is not yet completed.
RootSpanOperationName *string `mandatory:"false" json:"rootSpanOperationName"`
// Service associated with the trace.
RootSpanServiceName *string `mandatory:"false" json:"rootSpanServiceName"`
// Start time of the root span for the span collection.
TimeRootSpanStarted *common.SDKTime `mandatory:"false" json:"timeRootSpanStarted"`
// End time of the root span for the 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"`
}
func (m TraceSpanSummary) String() string
func (m TraceSpanSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly