Class: OCI::Loggingingestion::LoggingClient
- Inherits:
-
Object
- Object
- OCI::Loggingingestion::LoggingClient
- Defined in:
- lib/oci/loggingingestion/logging_client.rb
Overview
Use the Logging Ingestion API to ingest your application logs.
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) ⇒ LoggingClient
constructor
Creates a new LoggingClient.
-
#logger ⇒ Logger
The logger for this client.
-
#put_logs(log_id, put_logs_details, opts = {}) ⇒ Response
This API allows ingesting logs associated with a logId.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ LoggingClient
Creates a new LoggingClient. 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/loggingingestion/logging_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 + '/20200831' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "LoggingClient 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/loggingingestion/logging_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/loggingingestion/logging_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/loggingingestion/logging_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/loggingingestion/logging_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/loggingingestion/logging_client.rb', line 94 def logger @api_client.config.logger end |
#put_logs(log_id, put_logs_details, opts = {}) ⇒ Response
Click here to see an example of how to use put_logs API.
This API allows ingesting logs associated with a logId. A success response implies the data has been accepted.
120 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 |
# File 'lib/oci/loggingingestion/logging_client.rb', line 120 def put_logs(log_id, put_logs_details, opts = {}) logger.debug 'Calling operation LoggingClient#put_logs.' if logger raise "Missing the required parameter 'log_id' when calling put_logs." if log_id.nil? raise "Missing the required parameter 'put_logs_details' when calling put_logs." if put_logs_details.nil? raise "Parameter value for 'log_id' must not be blank" if OCI::Internal::Util.blank_string?(log_id) path = '/logs/{logId}/actions/push'.sub('{logId}', log_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'timestamp-opc-agent-processing'] = opts[:timestamp_opc_agent_processing] if opts[:timestamp_opc_agent_processing] header_params[:'opc-agent-version'] = opts[:opc_agent_version] if opts[:opc_agent_version] 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(put_logs_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'LoggingClient#put_logs') 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 ) end # rubocop:enable Metrics/BlockLength end |