diff --git a/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_application_tests.md b/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_application_tests.md new file mode 100644 index 000000000000000..20d607d8a03d6d0 --- /dev/null +++ b/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_application_tests.md @@ -0,0 +1,442 @@ +--- +# Code generator. DO NOT EDIT. + +title: DEX Application Tests +pcx_content_type: configuration +sidebar: + order: 21 +--- + +The descriptions below detail the fields available for `dex_application_tests`. + +## AccountID + +Type: `string` + +The Cloudflare account ID. + +## ClientPlatform + +Type: `string` + +The client's operating system. + +## ClientVersion + +Type: `string` + +The WARP client version. + +## ColoCode + +Type: `string` + +The Colo code where the WARP client is connected to Cloudflare. + +## DeviceID + +Type: `string` + +The unique device ID. + +## DeviceRegistrationID + +Type: `string` + +The unique ID for the device registration. + +## ExecutionContext + +Type: `string` + +Whether the test traffic was run inside or outside of the tunnel. Can be `inTunnel` or `outOfTunnel`. + +## HTTPClientIPASN + +Type: `int` + +HTTP test client IP autonomous system number, for example `13335`. HTTP tests only. + +## HTTPClientIPASO + +Type: `string` + +HTTP test client IP autonomous system organization, for example `Cloudflare, Inc.`. HTTP tests only. + +## HTTPClientIPAddress + +Type: `string` + +HTTP test client IP address. HTTP tests only. + +## HTTPClientIPCity + +Type: `string` + +HTTP test client IP city name in English language, for example `Los Angeles`. HTTP tests only. + +## HTTPClientIPCountryISO + +Type: `string` + +HTTP test client IP country ISO code, for example `US` for the United States. HTTP tests only. + +## HTTPClientIPNetmask + +Type: `string` + +HTTP test client IP netmask. HTTP tests only. + +## HTTPClientIPStateISO + +Type: `string` + +HTTP test client IP state ISO code, for example `CA` for California. HTTP tests only. + +## HTTPClientIPVersion + +Type: `string` + +HTTP test client IP version. HTTP tests only. + +## HTTPClientIPZip + +Type: `string` + +HTTP test client IP postal code, for example `90001`. HTTP tests only. + +## HTTPConnectEndMs + +Type: `int` + +HTTP test result connect end, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPConnectStartMs + +Type: `int` + +HTTP test result connect start, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPDomainLookupEndMs + +Type: `int` + +HTTP test result domain lookup end, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPDomainLookupStartMs + +Type: `int` + +HTTP test result domain lookup start, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPErrorMessage + +Type: `string` + +HTTP test result error message. HTTP tests only. + +## HTTPMethod + +Type: `string` + +HTTP test method. HTTP tests only. + +## HTTPRequestStartMs + +Type: `int` + +HTTP test result request start, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPResponseBodyBytes + +Type: `int` + +Size of the HTTP response body. HTTP tests only. + +## HTTPResponseEndMs + +Type: `int` + +HTTP test result response end, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPResponseHeaderBytes + +Type: `int` + +HTTP test result header bytes. HTTP tests only. + +## HTTPResponseStartMs + +Type: `int` + +HTTP test result response start, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPSecureConnectionStartMs + +Type: `int` + +HTTP test result secure connection start, in milliseconds since test start. HTTP tests only. Refer to [Resource timing](https://developer.mozilla.org/en-US/docs/Web/API/Resource_Timing_API/Using_the_Resource_Timing_API) for more details. + +## HTTPServerIPASN + +Type: `int` + +HTTP test server IP autonomous system number, for example `13335`. HTTP tests only. + +## HTTPServerIPASO + +Type: `string` + +HTTP test server IP autonomous system organization, for example `Cloudflare, Inc.`. HTTP tests only. + +## HTTPServerIPAddress + +Type: `string` + +HTTP test server IP address. HTTP tests only. + +## HTTPServerIPCity + +Type: `string` + +HTTP test server IP city name in English language, for example `Los Angeles`. HTTP tests only. + +## HTTPServerIPCountryISO + +Type: `string` + +HTTP test server IP country ISO code, for example `US` for the United States. HTTP tests only. + +## HTTPServerIPNetmask + +Type: `string` + +HTTP test server IP netmask. HTTP tests only. + +## HTTPServerIPStateISO + +Type: `string` + +HTTP test server IP state ISO code, for example `CA` for California. HTTP tests only. + +## HTTPServerIPVersion + +Type: `string` + +HTTP test server IP version. HTTP tests only. + +## HTTPServerIPZip + +Type: `string` + +HTTP test server IP postal code, for example `90001`. HTTP tests only. + +## HTTPStatusCode + +Type: `int` + +HTTP test result status code. HTTP tests only. + +## HTTPURL + +Type: `string` + +HTTP test target URL. HTTP tests only. + +## TestID + +Type: `string` + +The test ID for which the result was uploaded. + +## TestType + +Type: `string` + +The type of test. Can be `traceroute` or `http`. + +## Timestamp + +Type: `int or string` + +Test start time. + +## TracerouteDestinationHostname + +Type: `string` + +Traceroute test result destination hostname. Traceroute tests only. + +## TracerouteDestinationIPASN + +Type: `int` + +Traceroute test destination IP autonomous system number, for example `13335`. Traceroute tests only. + +## TracerouteDestinationIPASO + +Type: `string` + +Traceroute test destination IP autonomous system organization, for example `Cloudflare, Inc.`. Traceroute tests only. + +## TracerouteDestinationIPAddress + +Type: `string` + +Traceroute test destination IP address. Traceroute tests only. + +## TracerouteDestinationIPCity + +Type: `string` + +Traceroute test destination IP city name in English language, for example `Los Angeles`. Traceroute tests only. + +## TracerouteDestinationIPCountryISO + +Type: `string` + +Traceroute test destination IP country ISO code, for example `US` for the United States. Traceroute tests only. + +## TracerouteDestinationIPNetmask + +Type: `string` + +Traceroute test destination IP netmask. Traceroute tests only. + +## TracerouteDestinationIPStateISO + +Type: `string` + +Traceroute test destination IP state ISO code, for example `CA` for California. Traceroute tests only. + +## TracerouteDestinationIPVersion + +Type: `string` + +Traceroute test destination IP version. Traceroute tests only. + +## TracerouteDestinationIPZip + +Type: `string` + +Traceroute test destination IP postal code, for example `90001`. Traceroute tests only. + +## TracerouteDurationMs + +Type: `int` + +Traceroute test result duration in milliseconds. Traceroute tests only. + +## TracerouteHops + +Type: `array[object]` + +Traceroute test result hops, for example `[{"errors": ["timeout", "host unreachable"], "ip": {"address": "192.0.2.0", "asn": 13335, "aso": "Cloudflare, Inc.", "location": {"city": "Los Angeles", "countryISO": "US", "stateISO": "CA", "zip": "90001"}, "netmask": "255.255.255.0", "version": "v4"}, "name": "router1.example.com", "pathID": 1, "received": 3, "rtts": [10, 12, 11], "sent": 3, "ttl": 60}]`. Traceroute tests only. + +## TracerouteMaxTTL + +Type: `int` + +Traceroute test result maximum TTL value. Traceroute tests only. + +## TracerouteProtocol + +Type: `string` + +Traceroute test result protocol. Can be `icmp`, `udp`, or `tcp`. Traceroute tests only. + +## TracerouteSize + +Type: `int` + +Traceroute test result packet size in bytes. Traceroute tests only. + +## TracerouteSourceIPASN + +Type: `int` + +Traceroute test source IP autonomous system number, for example `13335`. Traceroute tests only. + +## TracerouteSourceIPASO + +Type: `string` + +Traceroute test source IP autonomous system organization, for example `Cloudflare, Inc.`. Traceroute tests only. + +## TracerouteSourceIPAddress + +Type: `string` + +Traceroute test source IP address. Traceroute tests only. + +## TracerouteSourceIPCity + +Type: `string` + +Traceroute test source IP city name in English language, for example `Los Angeles`. Traceroute tests only. + +## TracerouteSourceIPCountryISO + +Type: `string` + +Traceroute test source IP country ISO code, for example `US` for the United States. Traceroute tests only. + +## TracerouteSourceIPNetmask + +Type: `string` + +Traceroute test source IP netmask. Traceroute tests only. + +## TracerouteSourceIPStateISO + +Type: `string` + +Traceroute test source IP state ISO code, for example `CA` for California. Traceroute tests only. + +## TracerouteSourceIPVersion + +Type: `string` + +Traceroute test source IP version. Traceroute tests only. + +## TracerouteSourceIPZip + +Type: `string` + +Traceroute test source IP postal code, for example `90001`. Traceroute tests only. + +## TracerouteStatus + +Type: `string` + +Traceroute test result status. Can be `destinationReached`, `lastHopFailed`, or `maxHopsExhausted`. Traceroute tests only. + +## TracerouteTimeEnd + +Type: `int or string` + +Traceroute test result time end. Traceroute tests only. + +## TracerouteVersion + +Type: `string` + +The version of the WARP traceroute client. Traceroute tests only. + +## TunnelType + +Type: `string` + +The tunnel type the device uses to establish a connection to the edge, if any. Can be `http2`, `masque`, or `wireguard`. + +## UserEmail + +Type: `string` + +The Access user email. + +## UserID + +Type: `string` + +The Access user ID. diff --git a/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_device_state_events.md b/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_device_state_events.md new file mode 100644 index 000000000000000..ee9b032a68e5710 --- /dev/null +++ b/src/content/docs/logs/logpush/logpush-job/datasets/account/dex_device_state_events.md @@ -0,0 +1,358 @@ +--- +# Code generator. DO NOT EDIT. + +title: DEX Device State Events +pcx_content_type: configuration +sidebar: + order: 21 +--- + +The descriptions below detail the fields available for `dex_device_state_events`. + +## AccountID + +Type: `string` + +The Cloudflare account ID. + +## AlwaysOn + +Type: `bool` + +Whether the WARP daemon is configured to reconnect automatically or not. + +## AppFirewallEnabled + +Type: `bool` + +Whether the application-level firewall is enabled or disabled. + +## BatteryCharging + +Type: `bool` + +Whether the battery is charging or not. + +## BatteryCycles + +Type: `int` + +The number of battery cycles. May not be available on all platforms. + +## BatteryPercentage + +Type: `float` + +The percentage of battery remaining from 0 - 1. + +## CPUPercentage + +Type: `float` + +The percentage of CPU utilization from 0 - 1. + +## CPUPercentageByApp + +Type: `array[object]` + +The top applications by percentage of CPU used, for example `[{"name": "app0", "percentage": 0.55}, {"name": "app1", "percentage": 0.45}]`. + +## ClientPlatform + +Type: `string` + +The client's OS. + +## ClientVersion + +Type: `string` + +The WARP client version. + +## ConnectionType + +Type: `string` + +The type of connection the device has. Can be `cellular`, `ethernet`, or `wifi`. + +## DeviceID + +Type: `string` + +The unique device ID. + +## DeviceIPv4Address + +Type: `string` + +The device's private IPv4 address. + +## DeviceIPv4Netmask + +Type: `string` + +The device's private IPv4 netmask. + +## DeviceIPv6Address + +Type: `string` + +The device's private IPv6 address. + +## DeviceIPv6Netmask + +Type: `string` + +The device's private IPv6 netmask. + +## DeviceRegistrationID + +Type: `string` + +The unique ID for the device registration. + +## DiskReadBPS + +Type: `int` + +The number of disk bytes read per second. + +## DiskUsagePercentage + +Type: `float` + +The percentage of disk used from 0 - 1. + +## DiskWriteBPS + +Type: `int` + +The number of disk bytes written per second. + +## DoHSubdomain + +Type: `string` + +The WARP client's DoH subdomain. + +## FirewallEnabled + +Type: `bool` + +Whether the system-level firewall is enabled or disabled. + +## GatewayIPv4Address + +Type: `string` + +The private IPv4 address of the gateway/router the device is connected to. + +## GatewayIPv4Netmask + +Type: `string` + +The private IPv4 netmask of the gateway/router the device is connected to. + +## GatewayIPv6Address + +Type: `string` + +The private IPv6 address of the gateway/router the device is connected to. + +## GatewayIPv6Netmask + +Type: `string` + +The private IPv6 netmask of the gateway/router the device is connected to. + +## HandshakeLatencyMs + +Type: `int` + +When WARP is connected, the tunnel's estimated latency in milliseconds. When disconnected, -1. + +## ISPIPv4ASN + +Type: `int` + +The public IPv4 autonomous system number of the device assigned by the ISP, for example `13335`. + +## ISPIPv4ASO + +Type: `string` + +The public IPv4 autonomous system organization of the device assigned by the ISP, for example `Cloudflare Inc`. + +## ISPIPv4Address + +Type: `string` + +The public IPv4 address of the device assigned by the ISP. + +## ISPIPv4City + +Type: `string` + +The public IPv4 city name in English language of the device assigned by the ISP, for example `San Francisco`. + +## ISPIPv4CountryISO + +Type: `string` + +The public IPv4 country ISO code of the device assigned by the ISP, for example `US` for the United States. + +## ISPIPv4Netmask + +Type: `string` + +The public IPv4 netmask of the device assigned by the ISP. + +## ISPIPv4StateISO + +Type: `string` + +The public IPv4 state ISO code of the device assigned by the ISP, for example `CA` for California. + +## ISPIPv4Zip + +Type: `string` + +The public IPv4 postal code of the device assigned by the ISP, for example `90001`. + +## ISPIPv6ASN + +Type: `int` + +The public IPv6 autonomous system number of the device assigned by the ISP, for example `13335`. + +## ISPIPv6ASO + +Type: `string` + +The public IPv6 autonomous system organization of the device assigned by the ISP, for example `Cloudflare Inc`. + +## ISPIPv6Address + +Type: `string` + +The public IPv6 address of the device assigned by the ISP. + +## ISPIPv6City + +Type: `string` + +The public IPv6 city name in English language of the device assigned by the ISP, for example `San Francisco`. + +## ISPIPv6CountryISO + +Type: `string` + +The public IPv6 country ISO code of the device assigned by the ISP, for example `US` for the United States. + +## ISPIPv6Netmask + +Type: `string` + +The public IPv6 netmask of the device assigned by the ISP. + +## ISPIPv6StateISO + +Type: `string` + +The public IPv6 state ISO code of the device assigned by the ISP, for example `CA` for California. + +## ISPIPv6Zip + +Type: `string` + +The public IPv6 postal code of the device assigned by the ISP, for example `90001`. + +## Mode + +Type: `string` + +The WARP client connection mode, e.g. `warp+doh`, `proxy`. + +## NetworkReceivedBPS + +Type: `int` + +The number of network bytes received per second. + +## NetworkSSID + +Type: `string` + +The SSID of the network the device is connected to, max 32 characters. + +## NetworkSentBPS + +Type: `int` + +The number of network bytes sent per second. + +## RAMAvailableKB + +Type: `int` + +The total available RAM in kilobytes. + +## RAMUsedPercentage + +Type: `float` + +The percentage of RAM utilization from 0 - 1. + +## RAMUsedPercentageByApp + +Type: `array[object]` + +The top applications by percentage of RAM used, for example `[{"name": "app0", "percentage": 0.55}, {"name": "app1", "percentage": 0.45}]`. + +## Status + +Type: `string` + +The WARP client connection status, e.g. `connected`, `paused`. + +## SwitchLocked + +Type: `bool` + +Whether the WARP client was configured to always be enabled. + +## Timestamp + +Type: `int or string` + +Event timestamp. + +## TunnelStatsDownstream + +Type: `object` + +Warp Tunnel downstream stats, focused on MASQUE tunnels, for example `{"rttUs": 5, "minRttUs": 1, "rttVarUs": 1, "packetsSent": 100, "packetsLost": 50, "packetsRetransmitted": 25, "bytesSent": 1000, "bytesLost": 500, "bytesRetransmitted": 250}`. + +## TunnelStatsUpstream + +Type: `object` + +Warp Tunnel upstream stats, focused on MASQUE tunnels, for example `{"rttUs": 5, "minRttUs": 1, "rttVarUs": 1, "packetsSent": 100, "packetsLost": 50, "packetsRetransmitted": 25, "bytesSent": 1000, "bytesLost": 500, "bytesRetransmitted": 250}`. + +## TunnelType + +Type: `string` + +The tunnel type the device uses to establish a connection to the edge, if any. Can be `http2`, `masque`, or `wireguard`. + +## WarpColoCode + +Type: `string` + +The colo code where the client is connected to our API. e.g. `DFW` or `none`. + +## WiFiStrengthDBM + +Type: `int` + +The WiFi strength in decibel milliwatts. Scale between -30 and -90. diff --git a/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_config_changes.md b/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_config_changes.md new file mode 100644 index 000000000000000..30d9a5e65509d0e --- /dev/null +++ b/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_config_changes.md @@ -0,0 +1,76 @@ +--- +# Code generator. DO NOT EDIT. + +title: WARP Config Changes +pcx_content_type: configuration +sidebar: + order: 21 +--- + +The descriptions below detail the fields available for `warp_config_changes`. + +## AccountIDFrom + +Type: `string` + +The Cloudflare account ID the user switched from. + +## AccountIDTo + +Type: `string` + +The Cloudflare account ID the user switched to. + +## AccountNameFrom + +Type: `string` + +The name of the account the user switched from. + +## AccountNameTo + +Type: `string` + +The name of the account the user switched to. + +## ConfigNameFrom + +Type: `string` + +The name of the config the user switched from. + +## ConfigNameTo + +Type: `string` + +The name of the config the user switched to. + +## DeviceID + +Type: `string` + +Physical device ID. + +## DeviceRegistrationID + +Type: `string` + +Device registration ID. + +## Hostname + +Type: `string` + +The device hostname. + +## SerialNumber + +Type: `string` + +The device serial number. + +## Timestamp + +Type: `int or string` + +Time the event was ingested. diff --git a/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_toggle_changes.md b/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_toggle_changes.md new file mode 100644 index 000000000000000..b90c95a4af3df18 --- /dev/null +++ b/src/content/docs/logs/logpush/logpush-job/datasets/account/warp_toggle_changes.md @@ -0,0 +1,58 @@ +--- +# Code generator. DO NOT EDIT. + +title: WARP Toggle Changes +pcx_content_type: configuration +sidebar: + order: 21 +--- + +The descriptions below detail the fields available for `warp_toggle_changes`. + +## AccountID + +Type: `string` + +The Cloudflare account ID when the toggle happened. + +## AccountName + +Type: `string` + +The account name when the toggle happened. + +## DeviceID + +Type: `string` + +Physical device ID. + +## DeviceRegistrationID + +Type: `string` + +Device registration ID. + +## Hostname + +Type: `string` + +The device hostname. + +## SerialNumber + +Type: `string` + +The device serial number. + +## Timestamp + +Type: `int or string` + +Time the event was ingested. + +## Toggled + +Type: `bool` + +Indicates whether the device was toggled or not.