Log Fields (RTLD WAF)

• JSON: This format includes:
  • Top-level name/value pairs that uniquely identify the set of log entries reported in the JSON document.
  • An object for each log entry associated with the current JSON document.
  View a sample log file.
• JSON Array: This format generates a JSON document that contains an array of objects. Each object is a log entry associated with the current JSON document.
  View a sample log file.
• JSON Lines: This format generates an invalid JSON document that contains an object on each line. Each object is a log entry associated with the current JSON document. This object is an exact match for an object contained by the Logs array.
  View a sample log file.

Top-Level Name/Value Pairs #

• account_number (String): Customer AN. Identifies an environment by its legacy system-defined ID.
• agent_id (String): Agent ID. Indicates the unique ID that identifies the Real-Time Log Delivery software agent that generated the log data.
• datestamp (String): Date Stamp. Indicates the date on which the log data was generated.
  Syntax: YYYYMMDD
  Example: 20230412
• logs (Array of objects): Log Data. Describes the log entries associated with the current JSON document. Each object contains a set of fields that describe the request/response for a single log entry.
• profile_id (Integer): Profile ID. Identifies a RTLD profile by its system-defined ID.
• seq_num (Integer): Sequence Number. Indicates the sequential number that identifies the order in which the log data was generated by the software agent identified by the agent_id field.
• service (String): Service. This field always reports waf.

logs Array #

• account_number (String): Customer AN. (Category: General) Identifies an environment by its legacy system-defined ID.
• action_type (String): Action Type. (Category: Event) Indicates the action that was triggered as a result of the violation. Valid values are:
  • BLOCK_REQUEST: Indicates that the request that violated a rule was blocked.
  • NOP: Indicates that an alert was generated in response to the rule violation.
  • REDIRECT_302: Indicates that the request that violated a rule was redirected to a URL defined by your security policy.
  • CUSTOM_RESPONSE: Indicates that a custom response was returned to the client that submitted a request that violated a rule.
• client_city (String): City Name. (Category: Client Geography) Indicates the city from which the request originated.
• client_country_code (String): Country Code. (Category: Client Geography) Indicates the two-character ISO 3166-1 code for the country from which the request originated.
• client_country (String): Country Name. (Category: Client Geography) Indicates the country from which the request originated.
• client_ip (String): IP Address. (Category: Client Network) Indicates the IP address for the device that submitted the request to our CDN.
• client_tls_ja3_md5 (String): JA3 MD5 Hash. (Category: Request) Indicates the JA3 fingerprint assigned to the request. A JA3 fingerprint identifies a client using key characteristics from a TLS request. This allows us to classify traffic across various IP addresses and ports.
• host (String): Host. (Category: Request Header) Indicates the Host header value sent in the client’s request to the CDN.
• referer (String): Referer. (Category: Request Header) Indicates the Referer header value sent in the client’s request to the CDN. This header reports the URL of the site from which the request originated.
• rule_message (String): Rule Message. (Category: Event) Provides a description of the rule that the request violated.
• rule_tags (Array of strings): Rule Tags. (Category: Event) Indicates the tags associated with the rule that the request violated. These tags may be used to determine whether a rule, access control, or global setting was violated.
• server_port (Integer): Server Port. (Category: Network) Indicates the port number on an edge server to which the client directed a request. Valid values are:
  • 80: HTTP request
  • 443: HTTPS request
• sub_events_count (Integer): Sub Events Count. (Category: Sub Event) Indicates the total number of sub events.
• sub_events (Array of objects): Sub Events. (Category: Sub Event) Contains a list of fields that describe each sub event associated with the current event. A sub event is reported for each rule violation incurred by a request.
• timestamp (Decimal): Epoch Time. (Category: Response) Indicates the Unix time, in seconds, at which an edge server delivered the requested content to the client.
  Syntax: <SECONDS>.<MICROSECONDS>
• url (String): URL. (Category: Request) Indicates the URL that was requested.
• user_agent (String): User Agent. (Category: Request Header) Indicates the user agent that submitted the HTTP request to our CDN.
• uuid (String): Event ID. (Category: Request) Indicates the unique ID assigned to the event.
• waf_instance_name (String): Instance Name. (Category: Security Configuration) Indicates the name of the Security Application that the request violated.
• waf_profile_name (String): Profile Name. (Category: Security Configuration) Indicates the name of the profile that triggered the violation.
• waf_profile_type (String): Profile Type. (Category: Security Configuration) Indicates whether the request was screened as a result of an instance’s production or audit profile. Valid values are: PRODUCTION | AUDIT

sub_events Array #

• matched_on (String): Matched On. Indicates the variable that identifies where the violation was found.
• matched_value (String): Matched Value. Indicates the value of the variable defined in the matched_on field.
• rule_id (Integer): Rule ID. Indicates the ID for the rule that the request violated.
• rule_message (String): Rule Message. Provides a description of the rule that the request violated.
• total_anomaly_score (Integer): Total Anomaly Score. Indicates the total anomaly score for the current rule violation. This score is calculated by summing the anomaly score of the current rule violation with all rule violations reported above this sub event.
  Example: The anomaly score incurred by each sub event in this example is listed below.
  • Sub Event 1: Anomaly Score 2
  • Sub Event 2: Anomaly Score 3
  • Sub Event 3: Anomaly Score 2
  The total anomaly score for each sub event is listed below.
  • Sub Event 1: Total Anomaly Score = 2
  • Sub Event 2: Total Anomaly Score = 5
  • Sub Event 3: Total Anomaly Score = 7

Sample Log Data #

1{
2	"agent_id": "1234500008619D55A",
3	"seq_num": 0,
4	"service": "waf",
5	"account_number": "0001",
6	"profile_id": 0,
7	"datestamp": "20201008",
8	"logs": [{
9			"timestamp": 1602200337.177535713,
10			"user_agent": "curl/7.64.1",
11			"url": "https://cdn.example.com/",
12			"client_ip": "190.220.230.2",
13			"referer": "",
14			"host": "cdn.example.com",
15			"uuid": "38046679731278771327748811544613832704",
16			"client_country_code": "US",
17			"waf_profile_name": "Site 1",
18			"waf_profile_type": "PRODUCTION",
19			"waf_instance_name": "Site 1 Instance",
20			"sub_events_count": 1,
21			"sub_events": [{
22					"total_anomaly_score": 0,
23					"matched_on": "REQUEST_METHOD",
24					"matched_value": "POST",
25					"rule_id": 80009,
26					"rule_message": "Method is not allowed by policy"
27				}
28			],
29			"rule_tags": [],
30			"rule_message": "Method is not allowed by policy",
31			"action_type": "BLOCK_REQUEST",
32			"server_port": 443,
33			"client_country": "United States",
34			"client_city": "Los Angeles"
35		}, {
36			"timestamp": 1602200338.598465258,
37			"user_agent": "curl/7.64.1",
38			"url": "https://cdn.example.com/",
39			"client_ip": "230.180.240.23",
40			"referer": "",
41			"host": "cdn.example.com",
42			"uuid": "38046679731278771327748811544613832998",
43			"client_country_code": "US",
44			"waf_profile_name": "Site 1",
45			"waf_profile_type": "PRODUCTION",
46			"waf_instance_name": "Site 1 Instance",
47			"sub_events_count": 1,
48			"sub_events": [{
49					"total_anomaly_score": 0,
50					"matched_on": "REQUEST_METHOD",
51					"matched_value": "POST",
52					"rule_id": 80009,
53					"rule_message": "Method is not allowed by policy"
54				}
55			],
56			"rule_tags": [],
57			"rule_message": "Method is not allowed by policy",
58			"action_type": "BLOCK_REQUEST",
59			"server_port": 443,
60			"client_country": "United States",
61			"client_city": "Los Angeles"
62		}
63	]
64}

1[{
2		"timestamp": 1602200337.177535713,
3		"user_agent": "curl/7.64.1",
4		"url": "https://cdn.example.com/",
5		"client_ip": "190.220.230.2",
6		"referer": "",
7		"host": "cdn.example.com",
8		"uuid": "38046679731278771327748811544613832704",
9		"client_country_code": "US",
10		"waf_profile_name": "Site 1",
11		"waf_profile_type": "PRODUCTION",
12		"waf_instance_name": "Site 1 Instance",
13		"sub_events_count": 1,
14		"sub_events": [{
15				"total_anomaly_score": 0,
16				"matched_on": "REQUEST_METHOD",
17				"matched_value": "POST",
18				"rule_id": 80009,
19				"rule_message": "Method is not allowed by policy"
20			}
21		],
22		"rule_tags": [],
23		"rule_message": "Method is not allowed by policy",
24		"action_type": "BLOCK_REQUEST",
25		"server_port": 443,
26		"client_country": "United States",
27		"client_city": "Los Angeles"
28	}, {
29		"timestamp": 1602200338.598465258,
30		"user_agent": "curl/7.64.1",
31		"url": "https://cdn.example.com/",
32		"client_ip": "230.180.240.23",
33		"referer": "",
34		"host": "cdn.example.com",
35		"uuid": "38046679731278771327748811544613832998",
36		"client_country_code": "US",
37		"waf_profile_name": "Site 1",
38		"waf_profile_type": "PRODUCTION",
39		"waf_instance_name": "Site 1 Instance",
40		"sub_events_count": 1,
41		"sub_events": [{
42				"total_anomaly_score": 0,
43				"matched_on": "REQUEST_METHOD",
44				"matched_value": "POST",
45				"rule_id": 80009,
46				"rule_message": "Method is not allowed by policy"
47			}
48		],
49		"rule_tags": [],
50		"rule_message": "Method is not allowed by policy",
51		"action_type": "BLOCK_REQUEST",
52		"server_port": 443,
53		"client_country": "United States",
54		"client_city": "Los Angeles"
55	}
56]

1{"user_agent": "Mozilla/5.0 (Windows NT ... Represents a log entry.}
2{"user_agent": "Mozilla/5.0 (Windows NT ...}