Enriched Call Log Streams (ECLS) schema
Example JSON
Sample example
{
"data": [
{
"api_key": "",
"api_method_name": "v1 availability",
"bytes": "113",
"cache_hit": "0",
"client_transfer_time": "0.0",
"connect_time": "0.101",
"endpoint_name": "Inventory V1",
"http_method": "GET",
"http_status_code": "200",
"http_version": "HTTP/1.1",
"ingestion_time": "1555711021034",
"log_type": "SaaS",
"oauth_access_token": "-",
"package_name": "PetStore Package",
"package_uuid": "8c5f4216-7b4b-43b2-9e08-8613a804b69a",
"plan_name": "REST Access",
"plan_uuid": "7daeec13-16f2-4518-ba9d-2317257012a7",
"pre_transfer_time": "0.0",
"qps_throttle_value": "1",
"quota_value": "1",
"referrer": "-",
"remote_total_time": "0.081",
"request_host_name": "",
"request_id": "1555711003.068__fav6x8vp8wwcyj65m7yv3bzt",
"request_time": "2019-04-19T21:56:43Z",
"request_uuid": "132da36d-37b7-41e4-9d03-5e9f900f13c4",
"response_string": "200_OK_API",
"service_definition_endpoint_uuid": "6jwf2u7t74j7mmgc5dmbkjh6",
"service_id": "",
"service_name": "PetStore",
"src_ip": "12.34.56.789",
"ssl_enabled": "0",
"total_request_exec_time": "0.878",
"traffic_manager": "prod-j-worker-us-east-1b-52.acme.com",
"traffic_manager_error_code": "-",
"uri": "/v1/store/availability/100?api_key=",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML
like Gecko) Chrome/12.3.456.7 Safari/537.36"
"org_name": "organisationname",
"org_uuid": "xxnnxxnn",
"sub_org_name": "suborganisationname",
"sub_org_uuid": "xxnnxxxnnnn"
}
]
}
Schema Definition
| Field Name | Description | Data Type | Example |
|---|---|---|---|
api_key | API key used by application. | string | |
api_method_name | Name of method as configured via the Key & Method detection setting on the endpoint. | string | v1 availability |
bytes | Bytes in response. | integer | 113 |
cache_hit | Did Cloud API Management serve the request out of the cache? 1 = it did 0 = it didn't | integer | 0 |
client_transfer_time | Total time transferring from API Management to client on outbound. | float | 0 |
connect_time | Total time Traffic Manager negotiating connection with customer origin servers (0 value means reusing existing connection). | float | |
endpoint_name | Name of endpoint. | string | Inventory V1 |
http_method | HTTP method (GET, POST, PUT). | string | GET |
http_status_code | HTTP status code. | integer | 200 |
http_version | HTTP version. | string | HTTP/1.1 |
ingestion_time | Time (Epoch milliseconds format) when ECLS subsystem saw this log message. | long | 1555711021034 |
log_type | What is source on this log message - a Cloud API Management cluster (SaaS) or a Boomi Cloud API Management - Local Edition Cluster. Possible values: SaaS, ML. | string | SaaS |
oauth_access_token | OAuth access token value. | string | - |
package_name | Name of package. | string | PetStore Package |
package_uuid | Unique ID for the package, used with the V3 API. | string | 8c5f4216-7b4b-43b2-9e08-8613a804b69a |
plan_name | Name of plan. | string | REST Access |
plan_uuid | Unique ID for plan, used with the V3 API. | string | 7daeec13-16f2-4518-ba9d-2317257012a7 |
pre_transfer_time | Process time by prior to transfer. | float | |
qps_throttle_value | Queries per second throttle count value. | integer | 1 |
quota_value | Count against call quota. | integer | 1 |
referrer | Client referrer information. | string | - |
remote_total_time | Total call time spent waiting for response from origin by Cloud API Management. | float | 081 |
request_host_name | Name of host invoked by call. | string | |
request_id | ID of request (time(epoch)serviceidAPI_key) | string | 068_ |
request_time | Date/time when request was initiated with Cloud API Management (in ISO 8601 format) | string | 2019-04-19T21:56:43Z |
request_uuid | Unique ID for request. | string | 132da36d-37b7-41e4-9d03-5e9f900f13c4 |
response_string | Response string which includes source of error (Cloud API Management Vs Origin) | string | 200_OK_API |
service_definition_endpoint_uuid | UUID for endpoint, used with V3 API. | string | 6jwf2u7t74j7mmgc5dmbkjh6 |
service_id | Service ID (also sometimes known as SPKEY or Servicekey) | string | |
service_name | Name of service in which endpoint is located. | string | PetStore |
src_ip | Source IP address of client which initiated the request with Cloud API Management. | string | 12.34.567 |
ssl_enabled | The SSL used in inbound connection? 1=Yes 0=No | int | 0 |
total_request_exec_time | Total time from receipt of request to completion of response to client, formerly exec_time | float | 878 |
traffic_manager | Traffic manager host name. | string | prod-j-worker-us-east-1b-52.acme.com |
traffic_manager_error_code | Error code returned by Traffic Manager. | string | - |
uri | URI (with max length imposed). | string | /v1/store/availability/100?api_key= |
user_agent | User agent of client. | string | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML like Gecko) Chrome/73.0.3683.103 Safari/537.36 |
org_name | Name for the parent organization. Note: For an object not associated with the organization this value will be empty. | string | |
org_uuid | Unique identifier of the parent organization. Note: For an object not associated with the organization, this value will be empty. | string | |
sub_org_name | Name of the sub organization. Note: For an object not associated with the sub organization, this value will be empty. | string | |
sub_org_uuid | Unique identifier of the sub organization. Note: For an object not associated with the sub organization, this value will be empty. | string |
