oracle.oci.oci_apm_traces_trace_snapshot_facts – Fetches details about a TraceSnapshot resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.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_apm_traces_trace_snapshot_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a TraceSnapshot resource in Oracle Cloud Infrastructure

  • Gets the trace snapshots data identified by trace ID.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
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).
apm_domain_id
string / required
The APM Domain ID the request is intended for.
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.
is_summarized
boolean
    Choices:
  • no
  • yes
If enabled, then only span level details will be sent.
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.
snapshot_time
string
Epoch time of snapshot.
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
thread_id
string
Thread id for which snapshots needs to be retrieved. This is an identifier of a thread, and is a positive long number generated when when a thread is created.
trace_key
string / required
Unique Application Performance Monitoring trace identifier (traceId).

Examples

- name: Get a specific trace_snapshot
  oci_apm_traces_trace_snapshot_facts:
    # required
    apm_domain_id: "ocid1.apmdomain.oc1..xxxxxxEXAMPLExxxxxx"
    trace_key: trace_key_example

    # optional
    is_summarized: true
    thread_id: "ocid1.thread.oc1..xxxxxxEXAMPLExxxxxx"
    snapshot_time: snapshot_time_example

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
trace_snapshot
complex
on success
TraceSnapshot resource

Sample:
{'key': 'key_example', 'span_snapshots': [{'children': [{'children': [], 'key': 'key_example', 'span_name': 'span_name_example', 'span_snapshot_details': [], 'thread_snapshots': [], 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'key': 'key_example', 'span_name': 'span_name_example', 'span_snapshot_details': [{'key': 'key_example', 'value': {}}], 'thread_snapshots': [{'stack_trace': [{'class_name': 'class_name_example', 'file_name': 'file_name_example', 'line_number': 56, 'method_name': 'method_name_example', 'weightage': 3.4}], 'thread_snapshot_details': [{'key': 'key_example', 'value': {}}], 'time_stamp': '2013-10-20T19:20:30+01:00'}], 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00'}], 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'trace_snapshot_details': [{'key': 'key_example', 'value': {}}]}
 
key
string
on success
Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

Sample:
key_example
 
span_snapshots
complex
on success
List of spans.
   
children
complex
on success
An array of child span snapshots.
     
children
list / elements=string
on success
An array of child span snapshots.
     
key
string
on success
Unique identifier (spanId) for the trace span.

Sample:
key_example
     
span_name
string
on success
Span name associated with the trace.

Sample:
span_name_example
     
span_snapshot_details
list / elements=string
on success
Span snapshots properties.
     
thread_snapshots
list / elements=string
on success
Thread snapshots.
     
time_ended
string
on success
End time of the span.

Sample:
2013-10-20T19:20:30+01:00
     
time_started
string
on success
Start time of the span.

Sample:
2013-10-20T19:20:30+01:00
   
key
string
on success
Unique identifier (spanId) for the trace span.

Sample:
key_example
   
span_name
string
on success
Span name associated with the trace.

Sample:
span_name_example
   
span_snapshot_details
complex
on success
Span snapshots properties.
     
key
string
on success
Name of the property.

Sample:
key_example
     
value
dictionary
on success
Value of the property.
   
thread_snapshots
complex
on success
Thread snapshots.
     
stack_trace
complex
on success
Stack trace.
       
class_name
string
on success
Name of the class containing the execution point.

Sample:
class_name_example
       
file_name
string
on success
Name of the source file containing the execution point.

Sample:
file_name_example
       
line_number
integer
on success
Line number of the source line containing the execution point.

Sample:
56
       
method_name
string
on success
Name of the method containing the execution point.

Sample:
method_name_example
       
weightage
float
on success
The weight distribution that denotes the percentage occurrence of a method in the captured snapshots.

Sample:
3.4
     
thread_snapshot_details
complex
on success
Snapshot details.
       
key
string
on success
Name of the property.

Sample:
key_example
       
value
dictionary
on success
Value of the property.
     
time_stamp
string
on success
Snapshot time.

Sample:
2013-10-20T19:20:30+01:00
   
time_ended
string
on success
End time of the span.

Sample:
2013-10-20T19:20:30+01:00
   
time_started
string
on success
Start time of the span.

Sample:
2013-10-20T19:20:30+01:00
 
time_ended
string
on success
End time of the trace.

Sample:
2013-10-20T19:20:30+01:00
 
time_started
string
on success
Start time of the trace.

Sample:
2013-10-20T19:20:30+01:00
 
trace_snapshot_details
complex
on success
Trace snapshots properties.
   
key
string
on success
Name of the property.

Sample:
key_example
   
value
dictionary
on success
Value of the property.


Authors

  • Oracle (@oracle)