Skip to content

Commit b6fe843

Browse files
authored
Add developer docs for audit_log_v2 dataset logpush (#24354)
and update developer docs for logpush datasets
1 parent dee6314 commit b6fe843

File tree

6 files changed

+217
-3
lines changed

6 files changed

+217
-3
lines changed

src/content/docs/logs/logpush/logpush-job/datasets/account/audit_logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# Code generator. DO NOT EDIT.
33

4-
title: Audit logs
4+
title: Audit Logs
55
pcx_content_type: configuration
66
sidebar:
77
order: 21
Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
# Code generator. DO NOT EDIT.
3+
4+
title: Audit Logs V2
5+
pcx_content_type: configuration
6+
sidebar:
7+
order: 21
8+
---
9+
10+
The descriptions below detail the fields available for `audit_logs_v2`.
11+
12+
## AccountID
13+
14+
Type: `string`
15+
16+
The Cloudflare account ID.
17+
18+
## AccountName
19+
20+
Type: `string`
21+
22+
The Cloudflare account name.
23+
24+
## ActionDescription
25+
26+
Type: `string`
27+
28+
Description of action taken.
29+
30+
## ActionResult
31+
32+
Type: `string`
33+
34+
Whether the action was successful.
35+
36+
## ActionTimestamp
37+
38+
Type: `int or string`
39+
40+
When the change happened.
41+
42+
## ActionType
43+
44+
Type: `string`
45+
46+
Type of action taken.
47+
48+
## ActorContext
49+
50+
Type: `string`
51+
52+
Context of the actor.
53+
54+
## ActorEmail
55+
56+
Type: `string`
57+
58+
Email of the actor.
59+
60+
## ActorID
61+
62+
Type: `string`
63+
64+
Unique identifier of the actor in Cloudflare's system.
65+
66+
## ActorIPAddress
67+
68+
Type: `string`
69+
70+
Physical network address of the actor.
71+
72+
## ActorTokenDetails
73+
74+
Type: `object`
75+
76+
Details of how the actor is authenticated.
77+
78+
## ActorType
79+
80+
Type: `string`
81+
82+
Type of user that started the audit trail.
83+
84+
## AuditLogID
85+
86+
Type: `string`
87+
88+
Unique identifier of an audit log.
89+
90+
## Raw
91+
92+
Type: `object`
93+
94+
Raw data.
95+
96+
## ResourceID
97+
98+
Type: `string`
99+
100+
Unique identifier of the resource within Cloudflare's system.
101+
102+
## ResourceProduct
103+
104+
Type: `string`
105+
106+
Resource product.
107+
108+
## ResourceRequest
109+
110+
Type: `object`
111+
112+
Resource request.
113+
114+
## ResourceResponse
115+
116+
Type: `object`
117+
118+
Resource response.
119+
120+
## ResourceScope
121+
122+
Type: `string`
123+
124+
Resource scope.
125+
126+
## ResourceType
127+
128+
Type: `string`
129+
130+
The type of resource that was changed.
131+
132+
## ResourceValue
133+
134+
Type: `object`
135+
136+
Resource value.
137+
138+
## ZoneID
139+
140+
Type: `string`
141+
142+
The Cloudflare zone ID.
143+
144+
## ZoneName
145+
146+
Type: `string`
147+
148+
The Cloudflare zone name.

src/content/docs/logs/logpush/logpush-job/datasets/account/biso_user_actions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Type: `string`
2727

2828
The domain name in the URL.
2929

30+
## Metadata
31+
32+
Type: `string`
33+
34+
Additional information specific to a user action (JSON string).
35+
3036
## Timestamp
3137

3238
Type: `int or string`
@@ -45,6 +51,12 @@ Type: `string`
4551

4652
The URL of the webpage where a user action was performed.
4753

54+
## UserEmail
55+
56+
Type: `string`
57+
58+
The user email.
59+
4860
## UserID
4961

5062
Type: `string`

src/content/docs/logs/logpush/logpush-job/datasets/account/gateway_dns.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,18 @@ Type: `string`
261261

262262
The protocol used for the DNS query by the client (for example, 'udp').
263263

264+
## QueryApplicationIDs
265+
266+
Type: `array[int]`
267+
268+
ID or IDs of applications the queried domain belongs to (for example, [1, 51])
269+
270+
## QueryApplicationNames
271+
272+
Type: `array[string]`
273+
274+
Name or names of applications the queried domain belongs to (for example, ['Cloudflare Dashboard'])
275+
264276
## QueryCategoryIDs
265277

266278
Type: `array[int]`

src/content/docs/logs/logpush/logpush-job/datasets/account/zero_trust_network_sessions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,12 @@ Type: `string`
129129

130130
The name of the Cloudflare data center to which traffic ingressed.
131131

132+
## InitialOriginIP
133+
134+
Type: `string`
135+
136+
The IP used to correlate existing FQDN matching policy between Gateway DNS and Gateway proxy.
137+
132138
## Offramp
133139

134140
Type: `string`
@@ -189,6 +195,12 @@ Type: `string`
189195

190196
Identifier of the client registration which initiated the network session, if applicable (for example, WARP Registration ID).
191197

198+
## ResolvedFQDN
199+
200+
Type: `string`
201+
202+
The fully qualified domain name of the destination.
203+
192204
## RuleEvaluationDurationMs
193205

194206
Type: `int`

src/content/docs/logs/logpush/logpush-job/datasets/zone/http_requests.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ HTTP method of client request.
157157

158158
Type: `string`
159159

160-
URI path requested by the client.
160+
URI path requested by the client, which includes only the path portion of the requested URL, without the query string.
161161

162162
## ClientRequestProtocol
163163

@@ -187,7 +187,7 @@ Identifies requests as coming from an external source or another service within
187187

188188
Type: `string`
189189

190-
URI requested by the client.
190+
URI requested by the client, which includes the full path and query string of the requested URL.
191191

192192
## ClientRequestUserAgent
193193

@@ -345,6 +345,24 @@ Type: `int`
345345

346346
Total view of Time To First Byte as measured at Cloudflare's edge. Starts after a TCP connection is established and ends when Cloudflare begins returning the first byte of a response to eyeballs. Includes TLS handshake time (for new connections) and origin response time.
347347

348+
## FraudAttack
349+
350+
Type: `string`
351+
352+
The primary attack or use case detected in the request by Fraud detections.
353+
354+
## FraudDetectionIDs
355+
356+
Type: `array[int]`
357+
358+
List of IDs that correlate to the Fraud detections made on a request.
359+
360+
## FraudDetectionTags
361+
362+
Type: `array[string]`
363+
364+
List of tags that correlate to the Fraud detections made on a request.
365+
348366
## JA3Hash
349367

350368
Type: `string`
@@ -363,6 +381,12 @@ Type: `object`
363381

364382
Inter-request statistics computed for this JA4 fingerprint. JA4Signals field is organized in key:value pairs, where values are numbers. Available only for Bot Management customers. To enable this feature, contact your account team.
365383

384+
## JSDetectionPassed
385+
386+
Type: `string`
387+
388+
Whether the request passed background JavaScript Detection. <br />Possible values are <em>passed</em> \| <em>failed</em> \| <em>missing</em>. Available only for Bot Management customers. To enable this feature, contact your account team.
389+
366390
## LeakedCredentialCheckResult
367391

368392
Type: `string`
@@ -519,6 +543,12 @@ Type: `int`
519543

520544
The "upper tier" data center that was checked for a cached copy if Tiered Cache is used.
521545

546+
## VerifiedBotCategory
547+
548+
Type: `string`
549+
550+
The category of verified bot.
551+
522552
## WAFAttackScore
523553

524554
Type: `int`

0 commit comments

Comments
 (0)