Class: OCI::ApmTraces::QueryClient
- Inherits:
-
Object
- Object
- OCI::ApmTraces::QueryClient
- Defined in:
- lib/oci/apm_traces/query_client.rb
Overview
Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. For more information, see Application Performance Monitoring.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ QueryClient
constructor
Creates a new QueryClient.
-
#list_quick_picks(apm_domain_id, opts = {}) ⇒ Response
Returns a list of predefined Quick Pick queries intended to assist the user to choose a query to run.
-
#logger ⇒ Logger
The logger for this client.
-
#query(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, opts = {}) ⇒ Response
Retrieves the results (selected attributes and aggregations) of a query constructed according to the Application Performance Monitoring Defined Query Syntax.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ QueryClient
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.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/apm_traces/query_client.rb', line 55 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 |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/apm_traces/query_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/apm_traces/query_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/apm_traces/query_client.rb', line 29 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
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
25 26 27 |
# File 'lib/oci/apm_traces/query_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#list_quick_picks(apm_domain_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_quick_picks API.
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.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/oci/apm_traces/query_client.rb', line 121 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.(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 ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/apm_traces/query_client.rb', line 94 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 = {}) ⇒ Response
Click here to see an example of how to use query API.
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.
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/oci/apm_traces/query_client.rb', line 196 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.(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 |