Enriched Call Log Export (ECLE) FAQs

The following are frequently asked questions for the Call Log Export feature.

Q: What does the name, Enriched Call Log Export, mean?

A: With this feature, we aim to ensure you have all the necessary information to create meaningful analytics without the hassle of dealing with the data. Therefore, we have merged both call log data from the Traffic Manager with metadata such as API service name, Package name, Plan name, etc.. The addition of this data is referred to as Enriched.

Q: How is this data different from what's already available in the Cloud API Management reporting dashboard or API?

A: This is our first offering that provides call-level details, such as URI and IP address, for individual calls. The data in the reporting dashboard and API represent aggregated sets of data. For the first time, you can take call-level data and feed it into the data warehouse, using the visualization of your choice.

Q: How do I enable the Call Log Export feature?

A: If the feature is not enabled in your dashboard, it might be because you are not using the latest Control Center. The UI for this feature is not available for customers on the legacy dashboard. If you want to enable this feature, open a case via Boomi Support Center, providing the same information you would have needed to provide above.

Q: After creating a Call Export Profile, how long does it take to receive my first file?

A: Assuming your bucket is configured properly, and you have active traffic that matches the configured profile, you should see your first file in about 2-2.5 hours.

Q: What does the name of the files represent?

A: The file name has underscore-delimited values that represent:

1. Your Cloud API Management area name (the name of your instance).
2. The beginning of the time slice for the logs included in the file.
3. The ending time stamp of the time slice for logs included in the file.
4. The time stamp represents when the extraction was run.
5. The unique identifier, or UUID, of the Call Log Export Config (this UUID is helpful should you have multiple active profiles).

Q: Why does it take 30-45 minutes after the end of a period for a specific file to arrive in my bucket?

A: We are optimizing this feature to ensure it is as accurate as possible and that we deliver all logs at least once. We wait after the close of a time slice for late-arriving data to arrive. It then takes time to process and deliver the data.

Q: What are the causes of late-arriving data, and how do I receive it?

A: There are various reasons data could arrive well after the transaction time. Some examples include Cloud API Management - Local Edition log upload schedules or network issues between the traffic managers and our systems. If data arrives after we have started processing an export for a time slice, the export is delayed for approximately 10 hours. A new file is delivered that is named similarly to the previously delivered file, but it has a new extraction time element.

Q: There are calls missing. What's going on?

A: More often than not, missing files or call data are due to data arriving after the processing window has closed. Data is delivered in 30-minute time slices. Data has up to 30 minutes from the close of the time window to arrive and still be considered 'on time', and arrive in the normally scheduled deliveries. There are various reasons data could arrive after the transaction time. Some examples include Boomi Cloud API Management - Local Edition log upload schedules and network issues between the traffic managers and our systems. If data arrives after the processing window has ended, it is delivered roughly 4 hours later. Logs received more than 12 hours after the scheduled time are excluded from processing. A new file is delivered that is named similarly to the previously delivered file, but it has a new 'extraction time' element.

Q: Do I receive duplicate files?

A: Our goal with this feature is to deliver data at least once. This means that if we are in doubt about what you have received, we may resend it to you. The field request_uuid can be used within your system as an indexed field to prevent duplicates from being stored.

Q: What format does the file come in?

A: The files are gzip-compressed CSVs.

Q: Can I export data for a date prior to the current one?

A: Not currently, but this is under consideration for future development.

Q: What do the ECLE field names represent?

A: Refer to the ECLE field and description table below for more information about the field names.

ECLE Field and Description

Field Name	Description
api_key	API key used by the application. Provided both when used by itself and in relation to an OAuth2-based call.
api_method_name	Name of method as configured via the Key & Method detection setting on the endpoint.
bytes	Bytes in response.
cache_hit	True/false on cache hit served by Cloud API Management.
client_transfer_time	Total time transferring from Cloud API Management to the client on outbound.
connect_time	Total time Traffic Manager negotiating connection with customer origin servers (0 value means reusing existing connection).
endpoint_name	Name of endpoint.
http_method	HTTP method (GET, POST, etc.).
http_status_code	HTTP status code.
http_version	HTTP version.
oauth_access_token	OAuth access token value.
org_name	(string) Organization Name for the Parent organization. If the object is not associated with an Organization, then this value is empty.
org_uuid	(string) Unique identifier for a Parent organization. If the object is not associated with an Organization, then this value is empty.
package_name	Name of package.
package_uuid	Unique ID for the package, used with the V3 API.
plan_name	Name of plan.
plan_uuid	Unique GUID for plan, used with V3 API.
pre_transfer_time	Process time by Cloud API Management prior to transfer.
qps_throttle_value	Queries per second throttle count value.
quota_value	Count against call quota.
referrer	Client referrer information.
remote_total_time	Total call time spent waiting for response from origin by Cloud API Management.
request_host_name	Name of host invoked by call.
request_id	ID of request (time(epoch)+serviceid+API_key).
request_time	Date/time of request in ISO 8601.
request_uuid	Unique ID for request.
response_string	Response string which includes source of error (Cloud API Management Vs Origin).
service_definition_endpoint_uuid	UUID for endpoint, used with the V3 API.
service_id	Service ID (also sometimes known as SPKEY or Servicekey).
service_name	Name of service in which endpoint is located.
src_ip	Source IP address of client.
ssl_enabled	True/false, the SSL used in inbound connection.
sub_org_name	(string) Sub Organization Name. If the object is not associated with a Sub organization, then this value is empty.
sub_org_uuid	(string) Unique identifier for the Sub organization. If the object is not associated with a Sub organization, then this value is empty.
total_request_exec_time	Total time from receipt of request to completion of response to client, formerly exec_time.
traffic_manager	Traffic manager host name.
traffic_manager_error_code	Error code returned by Traffic Manager.
uri	URI (with max length imposed).
user_agent	User agent of client.