Enriched Access Logs
Log service generates the enriched access logs. The following table shows the order in which the fields are present in the logs.
| Field | Type | Description | Example |
|---|---|---|---|
| log_time | dateTime | Time of a log when the log is generated. | 15-02-2024 08:47:17.389 |
| log_level | string | Log level. It can be DEBUG, INFO, WARN, ERROR, and CRITICAL. | INFO |
| log_type | string | Type of a log. | PROXY_ACCESS |
| class_name | string | The log statement either finds "-" or a string. | "-" |
| request_host_name | string | The name of the host that took the call. | hapi.hoovers.com |
| src_ip | string | Originating IP address of the call. | 158.151.240.64 |
| ident | string | Global unique identifier (GUID) of the call. | 26e2fa2d-3e63-4ec8-8aaa-fb4643e601cf |
| record_type | string | Type of the call. It can be one of the following: - "-" - "tracked_call" - "value_event" | N/A |
| process_time | string | Date time when the request was processed. | [21/Apr/2014:21:25:46 +0000] |
| method | string | HTTP request method (GET, POST, PUT, DELETE, HEAD). | GET |
| uri | string | Path+query string portion of the request. | /TestAPI-34 |
| http_version | string | HTTP version. It can be 1.1 or 1.0. | HTTP/1.1 |
| bytes | integer | Bytes returned in the response. | 6668 |
| status | string | Three-digit HTTP response code. | 200 |
| referrer | string | Referring URL for the call if any. | app:/MarketMeSuite.swf |
| user_agent | string | Application that made the request. | curl/7.54.0 |
| request_id | string | Internal ID for this request. This is split into the following fields that are ingested: - request_time - Epoch micro time the request was received. - mapi - spkey :::note By default, the ::: | 1306282895.4215_bt6pnhuqhwew22xy7jmw7bar_x84p868ucwkkvxwwtc7uzw5h |
| referrer_domain | string | Domain portion of the referring URL for the call, if any. | |
| proxy_worker | string | A proxy worker that handled the request. | |
| api_method | string | API method called. | GetCompanyDetailRequest 34 |
| cache_hit | integer | Boolean value for whether a response is from a cache. If the value is 0, the response is not from the cache. | 0 or 1. |
| proxy_error_code | string | Internal error code for bouncing a request. If '-', the request is blocked from the endpoint. | ERR_403_DEVELOPER_INACTIVE |
| exec_time | float | Elapsed time in seconds from the moment the request is received at the proxy worker to the moment that a response is sent. | 0.745138884 |
| remote_total_time | float | Elapsed time in seconds, the backend call took. | 0.03747 |
| connect_time | float | Of the remote_total_time, how long, in seconds, it took to establish a connection before the first byte. | 0.001099 |
| pre_transfer_time | float | Of the remote total_time, how long, in seconds, it took after establishing a connection before receiving the first byte. | 0.001099 |
| reference_guid | string | Global unique identifier (GUID) of a call referenced by this call. | fcf87189-c3da-479d-b6b8-a848539f088c |
| user_agent_type | string | User agent type. "R" if the user agent matches as a robot; "-" otherwise. | "-" |
| oauth_access_token | string | Detected access token (on OAuth 2.0 protected resources). | |
| capacity_center_id | integer | On Premises capacity center identifier. | |
| capacity_center_name | string | OnPrem Capacity Center Name. | |
| ssl_enabled | number | A flag indicating whether SSL is enabled for the connection from the Traffic Manager to the Customer API. | 0 |
| quota_id | string | Quota id. | 476163 |
| quota_object_type | string | Quota object type. | 102 |
| quota_value | integer | Quota value. | 0 |
| throttle_id | string | Throttle id. | 476163 |
| throttle_object_type | string | Throttle object type. | 102 |
| throttle_value | integer | Throttle value. | 0 |
| service_aggregate_throttle_value | integer | Service aggregate throttle value. | 0 |
| area_aggregate_throttle_value | integer | Area aggregate throttle value. | 0 |
| plan_id | integer | Identifier of a plan. | 450 |
| service_definition_endpoint_id | integer | Unique identifier for the service endpoints. | 41090 |
| service_definition_method_id | integer | Service definition method id. | 12473 |
| resource_filter_id | integer | Resource filter. | 0 |
| stale_cache | integer | If the call is satisfied from cache, indicates whether the call is satisfied from a stale cache entry. If the call is not satisfied from the cache, the value is 0 always. | 0 |
| data_source | integer | It is a type of product serviced this call. SaaS = 0, MasheryLocal or ESG = 1. | 0 |
| bytes_in | integer | Size in bytes of incoming request. The default value is 0. | 0 |
| client_transfer_time | float | Time in seconds after the transfer of data is completed through the traffic manager, until the client has pulled down the last byte. | 0.00200 |
| log_version | string | It is used to support different versions of access call log generated by the traffic manager. | v3 |
| log_source | string | This field indicates whether the log is generated from or SaaS edition. The permissible values are local and SaaS. | local |
| log_ingestion | integer | Time required by a traffic manager. | 1687422162584 |
| area_id | integer | Identifier of a customer. | 222 |
| customer_name | string | Name of a customer. | |
| service_name | string | Name of service. | testService |
| service_definition_endpoint_uuid | string | Unique identifier for the Service Endpoints. | 3dcnbsdefv9ac2zd9qd2taq4 |
| endpoint_name | String | Endpoint name at for which the call is made. | Endpoint API 2 |
| plan_name | string | Plan Name for the endpoint. | Test plan |
| plan_uuid | string | Unique identifier of a plan. | d670a9f7-b523-4deb-b205-66b087020f42 |
| package_id | integer | Identifier of a package. | |
| package_name | string | Package name for which api_key is used. | TestPackage |
| package_uuid | string | Unique identifier for the package. | 58c0b3cb-268e-4e92-bd08-1e38da4e1ac9 |
| org_uuid | Unique identifier of an organization. | ||
| org_name | string | Name of an organization. | |
| sub_org_uuid | integer | Unique identifier of a sub organization. | 93 |
| sub_org_name | string | Name of a sub organization. | SBO |
| cluster_name | string | Name of the cluster from where the traffic is served. | b2cprod |
| pre_process_time | float | Adapter preprocess time. | 0.000 |
| post_process_time | float | Adapter post process time. | 0.000 |
| responsestr | string | generates the response string with source information. | 200 OK (API) |
| responsestr_no_source | string | generates the response string without any source information. | 200 OK |
| counts_toward_rate_limit | boolean | Whether the access log should be counted in rate limiting. The acceptable values are true and false. | true |
| optional_v3 | string | This field is not used for 6.0.0. The default value is "-". | "-" |
| class | string | This field captures class name details. The default value is "-". | "-" |
Location of Enriched Access Logs
/mnt/data/trafficmanager/enriched/access/access*.log
Sample log output
15-02-2024 08:47:17.389 INFO PROXY_ACCESS - tml.api.mashspud.com 10.128.0.81
dd1a5b27-e3ea-4139-95a4-a72c1609673e - [15/Feb/2024:08:47:17 +0000] "GET /test3?api_
key=XXXXX HTTP/1.1" 25 200 "-" "curl/7.29.0" 1707986837.343_test3_
b2qxuqhyh652hma8jw99gx5y "-" "trafficmanager-deploy-6c8fbb8f54-64ghp" "-" 0 - 0.045 0.030
0.000 0.000 - - - - - 0 6312 100 2 6312 100 1 0 0 6312 171234 0 0 0 0 0 0.000 v3 local
1707986837388 2222 "tml" "Test_API3" 3dcnbsdefv9ac2zd9qd2taq4 "Test_EP3" "Test_Plan3"
d670a9f7-b523-4deb-b205-66b087020f42 0 "Test_Pack3" 447ae50c-349e-4386-abb9-
0db67a64479e - "-" - "-" "-" 0.000 0.000 "200 OK (API)" "200 OK" true "-"