oracle.oci.oci_apm_traces_trace_facts – Fetches details about a Trace 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_apm_traces_trace_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a Trace resource in Oracle Cloud Infrastructure

  • Gets the trace details identified by traceId.

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.
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.
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
trace_key
string / required
Unique Application Performance Monitoring trace identifier (traceId).

Examples

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

Return Values

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

Key Returned Description
trace
complex
on success
Trace resource

Sample:
{'error_span_count': 56, 'is_fault': True, 'key': 'key_example', 'root_span_duration_in_ms': 56, 'root_span_operation_name': 'root_span_operation_name_example', 'root_span_service_name': 'root_span_service_name_example', 'service_summaries': [{'error_spans': 56, 'span_service_name': 'span_service_name_example', 'total_spans': 56}], 'span_count': 56, 'span_summary': {'error_span_count': 56, 'is_fault': True, 'key': 'key_example', 'root_span_duration_in_ms': 56, 'root_span_operation_name': 'root_span_operation_name_example', 'root_span_service_name': 'root_span_service_name_example', 'service_summaries': [{'error_spans': 56, 'span_service_name': 'span_service_name_example', 'total_spans': 56}], 'span_count': 56, 'time_earliest_span_started': '2013-10-20T19:20:30+01:00', 'time_latest_span_ended': '2013-10-20T19:20:30+01:00', 'time_root_span_ended': '2013-10-20T19:20:30+01:00', 'time_root_span_started': '2013-10-20T19:20:30+01:00', 'trace_duration_in_ms': 56, 'trace_error_code': 'trace_error_code_example', 'trace_error_type': 'trace_error_type_example', 'trace_status': 'trace_status_example'}, 'spans': [{'duration_in_ms': 56, 'is_error': True, 'key': 'key_example', 'kind': 'kind_example', 'logs': [{'span_logs': [{'log_key': 'log_key_example', 'log_value': 'log_value_example'}], 'time_created': '2013-10-20T19:20:30+01:00'}], 'operation_name': 'operation_name_example', 'parent_span_key': 'parent_span_key_example', 'service_name': 'service_name_example', 'tags': [{'tag_name': 'tag_name_example', 'tag_value': 'tag_value_example'}], 'time_ended': '2013-10-20T19:20:30+01:00', 'time_started': '2013-10-20T19:20:30+01:00', 'trace_key': 'trace_key_example'}], 'time_earliest_span_started': '2013-10-20T19:20:30+01:00', 'time_latest_span_ended': '2013-10-20T19:20:30+01:00', 'time_root_span_ended': '2013-10-20T19:20:30+01:00', 'time_root_span_started': '2013-10-20T19:20:30+01:00', 'trace_duration_in_ms': 56, 'trace_error_code': 'trace_error_code_example', 'trace_error_type': 'trace_error_type_example', 'trace_status': 'trace_status_example'}
 
error_span_count
integer
on success
The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

Sample:
56
 
is_fault
boolean
on success
Boolean flag that indicates whether the trace has an error.

Sample:
True
 
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
 
root_span_duration_in_ms
integer
on success
Time taken for the root span operation to complete in milliseconds.

Sample:
56
 
root_span_operation_name
string
on success
Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

Sample:
root_span_operation_name_example
 
root_span_service_name
string
on success
Service associated with the trace.

Sample:
root_span_service_name_example
 
service_summaries
complex
on success
A summary of the spans by service.

   
error_spans
integer
on success
Number of spans with errors for serviceName in the trace.

Sample:
56
   
span_service_name
string
on success
Name associated with the service.

Sample:
span_service_name_example
   
total_spans
integer
on success
Number of spans for serviceName in the trace.

Sample:
56
 
span_count
integer
on success
The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

Sample:
56
 
span_summary
complex
on success

   
error_span_count
integer
on success
The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

Sample:
56
   
is_fault
boolean
on success
Boolean flag that indicates whether the trace has an error.

Sample:
True
   
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
   
root_span_duration_in_ms
integer
on success
Time taken for the root span operation to complete in milliseconds.

Sample:
56
   
root_span_operation_name
string
on success
Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

Sample:
root_span_operation_name_example
   
root_span_service_name
string
on success
Service associated with the trace.

Sample:
root_span_service_name_example
   
service_summaries
complex
on success
A summary of the spans by service.

     
error_spans
integer
on success
Number of spans with errors for serviceName in the trace.

Sample:
56
     
span_service_name
string
on success
Name associated with the service.

Sample:
span_service_name_example
     
total_spans
integer
on success
Number of spans for serviceName in the trace.

Sample:
56
   
span_count
integer
on success
The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

Sample:
56
   
time_earliest_span_started
string
on success
Start time of the earliest span in the span collection.

Sample:
2013-10-20T19:20:30+01:00
   
time_latest_span_ended
string
on success
End time of the span that most recently ended in the span collection.

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

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

Sample:
2013-10-20T19:20:30+01:00
   
trace_duration_in_ms
integer
on success
Time between the start of the earliest span and the end of the most recent span in milliseconds.

Sample:
56
   
trace_error_code
string
on success
Error code of the trace.

Sample:
trace_error_code_example
   
trace_error_type
string
on success
Error type of the trace.

Sample:
trace_error_type_example
   
trace_status
string
on success
The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

Sample:
trace_status_example
 
spans
complex
on success
An array of spans in the trace.

   
duration_in_ms
integer
on success
Total span duration in milliseconds.

Sample:
56
   
is_error
boolean
on success
Indicates if the span has an error.

Sample:
True
   
key
string
on success
Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.

Sample:
key_example
   
kind
string
on success
Kind associated with the span.

Sample:
kind_example
   
logs
complex
on success
List of logs associated with the span.

     
span_logs
complex
on success
List of logs associated with the span at the given timestamp.

       
log_key
string
on success
Key that specifies the log name.

Sample:
log_key_example
       
log_value
string
on success
Value associated with the log key.

Sample:
log_value_example
     
time_created
string
on success
Timestamp at which the log is created.

Sample:
2013-10-20T19:20:30+01:00
   
operation_name
string
on success
Span name associated with the trace. This is usually the method or URI of the request.

Sample:
operation_name_example
   
parent_span_key
string
on success
Unique parent identifier for the span if one exists. For root spans this will be null.

Sample:
parent_span_key_example
   
service_name
string
on success
Service name associated with the span.

Sample:
service_name_example
   
tags
complex
on success
List of tags associated with the span.

     
tag_name
string
on success
Key that specifies the tag name.

Sample:
tag_name_example
     
tag_value
string
on success
Value associated with the tag key.

Sample:
tag_value_example
   
time_ended
string
on success
Span end time. Timestamp when the span was completed.

Sample:
2013-10-20T19:20:30+01:00
   
time_started
string
on success
Span start time. Timestamp when the span was started.

Sample:
2013-10-20T19:20:30+01:00
   
trace_key
string
on success
Unique identifier for the trace.

Sample:
trace_key_example
 
time_earliest_span_started
string
on success
Start time of the earliest span in the span collection.

Sample:
2013-10-20T19:20:30+01:00
 
time_latest_span_ended
string
on success
End time of the span that most recently ended in the span collection.

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

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

Sample:
2013-10-20T19:20:30+01:00
 
trace_duration_in_ms
integer
on success
Time between the start of the earliest span and the end of the most recent span in milliseconds.

Sample:
56
 
trace_error_code
string
on success
Error code of the trace.

Sample:
trace_error_code_example
 
trace_error_type
string
on success
Error type of the trace.

Sample:
trace_error_type_example
 
trace_status
string
on success
The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

Sample:
trace_status_example


Authors

  • Oracle (@oracle)