Class: OCI::ApmTraces::TraceClient
- Inherits:
-
Object
- Object
- OCI::ApmTraces::TraceClient
- Defined in:
- lib/oci/apm_traces/trace_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
-
#get_aggregated_snapshot(apm_domain_id, trace_key, opts = {}) ⇒ Response
Gets the aggregated snapshot identified by trace ID.
-
#get_span(apm_domain_id, span_key, trace_key, opts = {}) ⇒ Response
Gets the span details identified by spanId.
-
#get_trace(apm_domain_id, trace_key, opts = {}) ⇒ Response
Gets the trace details identified by traceId.
-
#get_trace_snapshot(apm_domain_id, trace_key, opts = {}) ⇒ Response
Gets the trace snapshots data identified by trace ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ TraceClient
constructor
Creates a new TraceClient.
-
#logger ⇒ Logger
The logger for this client.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ TraceClient
Creates a new TraceClient. 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/trace_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 "TraceClient 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/trace_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/trace_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/trace_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/trace_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#get_aggregated_snapshot(apm_domain_id, trace_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_aggregated_snapshot API.
Gets the aggregated snapshot identified by trace ID.
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 160 161 162 163 164 165 166 167 |
# File 'lib/oci/apm_traces/trace_client.rb', line 125 def get_aggregated_snapshot(apm_domain_id, trace_key, opts = {}) logger.debug 'Calling operation TraceClient#get_aggregated_snapshot.' if logger raise "Missing the required parameter 'apm_domain_id' when calling get_aggregated_snapshot." if apm_domain_id.nil? raise "Missing the required parameter 'trace_key' when calling get_aggregated_snapshot." if trace_key.nil? raise "Parameter value for 'trace_key' must not be blank" if OCI::Internal::Util.blank_string?(trace_key) path = '/traces/{traceKey}/aggregatedSnapshotData'.sub('{traceKey}', trace_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id query_params[:serviceName] = opts[:service_name] if opts[:service_name] query_params[:serverName] = opts[:server_name] if opts[:server_name] query_params[:spanKey] = opts[:span_key] if opts[:span_key] query_params[:spanName] = opts[:span_name] if opts[:span_name] # 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: 'TraceClient#get_aggregated_snapshot') 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: 'OCI::ApmTraces::Models::AggregatedSnapshot' ) end # rubocop:enable Metrics/BlockLength end |
#get_span(apm_domain_id, span_key, trace_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_span API.
Gets the span details identified by spanId.
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 240 241 242 243 244 245 246 247 |
# File 'lib/oci/apm_traces/trace_client.rb', line 200 def get_span(apm_domain_id, span_key, trace_key, opts = {}) logger.debug 'Calling operation TraceClient#get_span.' if logger raise "Missing the required parameter 'apm_domain_id' when calling get_span." if apm_domain_id.nil? raise "Missing the required parameter 'span_key' when calling get_span." if span_key.nil? raise "Missing the required parameter 'trace_key' when calling get_span." if trace_key.nil? if opts[:span_namespace] && !%w[TRACES SYNTHETIC].include?(opts[:span_namespace]) raise 'Invalid value for "span_namespace", must be one of TRACES, SYNTHETIC.' end raise "Parameter value for 'span_key' must not be blank" if OCI::Internal::Util.blank_string?(span_key) raise "Parameter value for 'trace_key' must not be blank" if OCI::Internal::Util.blank_string?(trace_key) path = '/spans/{traceKey}/{spanKey}'.sub('{spanKey}', span_key.to_s).sub('{traceKey}', trace_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id query_params[:timeSpanStartedGreaterThanOrEqualTo] = opts[:time_span_started_greater_than_or_equal_to] if opts[:time_span_started_greater_than_or_equal_to] query_params[:timeSpanStartedLessThan] = opts[:time_span_started_less_than] if opts[:time_span_started_less_than] query_params[:spanNamespace] = opts[:span_namespace] if opts[:span_namespace] # 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: 'TraceClient#get_span') 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: 'OCI::ApmTraces::Models::Span' ) end # rubocop:enable Metrics/BlockLength end |
#get_trace(apm_domain_id, trace_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_trace API.
Gets the trace details identified by traceId.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/oci/apm_traces/trace_client.rb', line 278 def get_trace(apm_domain_id, trace_key, opts = {}) logger.debug 'Calling operation TraceClient#get_trace.' if logger raise "Missing the required parameter 'apm_domain_id' when calling get_trace." if apm_domain_id.nil? raise "Missing the required parameter 'trace_key' when calling get_trace." if trace_key.nil? if opts[:trace_namespace] && !%w[TRACES SYNTHETIC].include?(opts[:trace_namespace]) raise 'Invalid value for "trace_namespace", must be one of TRACES, SYNTHETIC.' end raise "Parameter value for 'trace_key' must not be blank" if OCI::Internal::Util.blank_string?(trace_key) path = '/traces/{traceKey}'.sub('{traceKey}', trace_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id query_params[:timeTraceStartedGreaterThanOrEqualTo] = opts[:time_trace_started_greater_than_or_equal_to] if opts[:time_trace_started_greater_than_or_equal_to] query_params[:timeTraceStartedLessThan] = opts[:time_trace_started_less_than] if opts[:time_trace_started_less_than] query_params[:traceNamespace] = opts[:trace_namespace] if opts[:trace_namespace] # 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: 'TraceClient#get_trace') 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: 'OCI::ApmTraces::Models::Trace' ) end # rubocop:enable Metrics/BlockLength end |
#get_trace_snapshot(apm_domain_id, trace_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_trace_snapshot API.
Gets the trace snapshots data identified by trace ID.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/oci/apm_traces/trace_client.rb', line 353 def get_trace_snapshot(apm_domain_id, trace_key, opts = {}) logger.debug 'Calling operation TraceClient#get_trace_snapshot.' if logger raise "Missing the required parameter 'apm_domain_id' when calling get_trace_snapshot." if apm_domain_id.nil? raise "Missing the required parameter 'trace_key' when calling get_trace_snapshot." if trace_key.nil? raise "Parameter value for 'trace_key' must not be blank" if OCI::Internal::Util.blank_string?(trace_key) path = '/traces/{traceKey}/snapshotData'.sub('{traceKey}', trace_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:apmDomainId] = apm_domain_id query_params[:isSummarized] = opts[:is_summarized] if !opts[:is_summarized].nil? query_params[:threadId] = opts[:thread_id] if opts[:thread_id] query_params[:snapshotTime] = opts[:snapshot_time] if opts[:snapshot_time] # 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: 'TraceClient#get_trace_snapshot') 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: 'OCI::ApmTraces::Models::TraceSnapshot' ) 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/trace_client.rb', line 94 def logger @api_client.config.logger end |