class OCI::ApmTraces::QueryClient

API for APM Trace service. Use this API to query the Traces and associated Spans.

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new QueryClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then

a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
so that the instance principals signer can be provided to the client

@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests

the details for the proxy can be provided in this parameter

@param [OCI::Retry::RetryConfig] retry_config The retry configuration for this service client. This represents the default retry configuration to

apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation
will not perform any retries
# File lib/oci/apm_traces/query_client.rb, line 53
def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20200630'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "QueryClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

list_quick_picks(apm_domain_id, opts = {}) click to toggle source

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.

@param [String] apm_domain_id The APM Domain Id the request is intended for.

@param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

particular request, please provide the request ID.

@option opts [Integer] :limit The maximum number of items to return.

(default to 50)

@option opts [String] :page The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous response.
 (default to 1)

@return [Response] A Response object with data of type Array<{OCI::ApmTraces::Models::QuickPickSummary QuickPickSummary}> @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmtraces/list_quick_picks.rb.html) to see an example of how to use list_quick_picks API.

# File lib/oci/apm_traces/query_client.rb, line 119
def list_quick_picks(apm_domain_id, opts = {})
  logger.debug 'Calling operation QueryClient#list_quick_picks.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling list_quick_picks." if apm_domain_id.nil?

  path = '/queries/quickPicks'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'QueryClient#list_quick_picks') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::ApmTraces::Models::QuickPickSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/apm_traces/query_client.rb, line 92
def logger
  @api_client.config.logger
end
query(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, opts = {}) click to toggle source

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.

@param [String] apm_domain_id The APM Domain Id the request is intended for.

@param [DateTime] time_span_started_greater_than_or_equal_to Include spans that have a `spanStartTime` equal to or greater this value.

@param [DateTime] time_span_started_less_than Include spans that have a `spanStartTime`less than this value.

@param [OCI::ApmTraces::Models::QueryDetails] query_details Request body containing the query to be run against our repository.

@param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

particular request, please provide the request ID.

@option opts [Integer] :limit The maximum number of items to return.

(default to 50)

@option opts [String] :page The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous response.
 (default to 1)

@return [Response] A Response object with data of type {OCI::ApmTraces::Models::QueryResultResponse QueryResultResponse} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmtraces/query.rb.html) to see an example of how to use query API.

# File lib/oci/apm_traces/query_client.rb, line 193
def query(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, opts = {})
  logger.debug 'Calling operation QueryClient#query.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling query." if apm_domain_id.nil?
  raise "Missing the required parameter 'time_span_started_greater_than_or_equal_to' when calling query." if time_span_started_greater_than_or_equal_to.nil?
  raise "Missing the required parameter 'time_span_started_less_than' when calling query." if time_span_started_less_than.nil?
  raise "Missing the required parameter 'query_details' when calling query." if query_details.nil?

  path = '/queries/actions/runQuery'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:timeSpanStartedGreaterThanOrEqualTo] = time_span_started_greater_than_or_equal_to
  query_params[:timeSpanStartedLessThan] = time_span_started_less_than
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(query_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'QueryClient#query') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ApmTraces::Models::QueryResultResponse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
query_old(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, opts = {}) click to toggle source

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.

@param [String] apm_domain_id The APM Domain Id the request is intended for.

@param [DateTime] time_span_started_greater_than_or_equal_to Include spans that have a `spanStartTime` equal to or greater this value.

@param [DateTime] time_span_started_less_than Include spans that have a `spanStartTime`less than this value.

@param [OCI::ApmTraces::Models::QueryDetails] query_details Request body containing the query to be run against our repository.

@param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_request_id Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

particular request, please provide the request ID.

@option opts [Integer] :limit The maximum number of items to return.

(default to 50)

@option opts [String] :page The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous response.
 (default to 1)

@return [Response] A Response object with data of type {OCI::ApmTraces::Models::QueryResultResponse QueryResultResponse} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/apmtraces/query_old.rb.html) to see an example of how to use query_old API.

# File lib/oci/apm_traces/query_client.rb, line 274
def query_old(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, opts = {})
  logger.debug 'Calling operation QueryClient#query_old.' if logger

  raise "Missing the required parameter 'apm_domain_id' when calling query_old." if apm_domain_id.nil?
  raise "Missing the required parameter 'time_span_started_greater_than_or_equal_to' when calling query_old." if time_span_started_greater_than_or_equal_to.nil?
  raise "Missing the required parameter 'time_span_started_less_than' when calling query_old." if time_span_started_less_than.nil?
  raise "Missing the required parameter 'query_details' when calling query_old." if query_details.nil?

  path = '/queries/action/runQuery'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:apmDomainId] = apm_domain_id
  query_params[:timeSpanStartedGreaterThanOrEqualTo] = time_span_started_greater_than_or_equal_to
  query_params[:timeSpanStartedLessThan] = time_span_started_less_than
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(query_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'QueryClient#query_old') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::ApmTraces::Models::QueryResultResponse'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
region=(new_region) click to toggle source

Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

# File lib/oci/apm_traces/query_client.rb, line 82
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://apm-trace.{region}.oci.{secondLevelDomain}') + '/20200630'
  logger.info "QueryClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines

# File lib/oci/apm_traces/query_client.rb, line 324
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end