oracle.oci.oci_loggingingestion_log_entry_actions – Perform actions on a LogEntry resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_loggingingestion_log_entry_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a LogEntry resource in Oracle Cloud Infrastructure

  • For action=put_logs, this API allows ingesting logs associated with a logId. A success response implies the data has been accepted.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • put_logs
The action to perform on the LogEntry.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
log_entry_batches
list / elements=dictionary / required
List of log-batches. Each batch has a single source, type and subject.
defaultlogentrytime
string / required
The timestamp for all log entries in this batch. This can be considered as the default timestamp for each entry, unless it is overwritten by the entry time. An RFC3339-formatted date-time string with milliseconds precision.
entries
list / elements=dictionary / required
List of data entries.
data
string / required
The log entry content.
id
string / required
UUID uniquely representing this logEntry. This is not an OCID related to any oracle resource.
time
string
Optional. The timestamp associated with the log entry. An RFC3339-formatted date-time string with milliseconds precision. If unspecified, defaults to PutLogsDetails.defaultlogentrytime.
source
string / required
Source of the logs that generated the message. This could be the instance name, hostname, or the source used to read the event. For example, "ServerA".
subject
string
This optional field is useful for specifying the specific sub-resource or input file used to read the event. For example: "/var/log/application.log".
type
string / required
This field signifies the type of logs being ingested. For example: ServerA.requestLogs.
log_id
string / required
OCID of a log to work with.

aliases: id
opc_agent_version
string
Version of the agent sending the request.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
specversion
string / required
Required for identifying the version of the data format being used. Permitted values include: "1.0"
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
timestamp_opc_agent_processing
string
Effective timestamp, for when the agent started processing the log segment being sent. An RFC3339-formatted date-time string with milliseconds precision.

Examples

- name: Perform action put_logs on log_entry
  oci_loggingingestion_log_entry_actions:
    # required
    log_id: "ocid1.log.oc1..xxxxxxEXAMPLExxxxxx"
    specversion: specversion_example
    log_entry_batches:
    - # required
      entries:
      - # required
        data: data_example
        id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        time: time_example
      source: source_example
      type: type_example
      defaultlogentrytime: defaultlogentrytime_example

      # optional
      subject: subject_example
    action: put_logs

    # optional
    timestamp_opc_agent_processing: 2013-10-20T19:20:30+01:00
    opc_agent_version: opc_agent_version_example

Authors

  • Oracle (@oracle)