From c64ecc4575608ea4958d4233107704ea58decc7f Mon Sep 17 00:00:00 2001 From: Sohei Gallagher Date: Wed, 15 Jan 2025 01:08:29 -0800 Subject: [PATCH] [Logs] Update Log fields This updates Log fields. They are synced from internal `entities` repo's fields templates. --- .../log-fields/account/gateway_dns.md | 46 ++++++- .../reference/log-fields/account/ssh_logs.md | 118 ++++++++++++++++++ 2 files changed, 159 insertions(+), 5 deletions(-) create mode 100644 src/content/docs/logs/reference/log-fields/account/ssh_logs.md diff --git a/src/content/docs/logs/reference/log-fields/account/gateway_dns.md b/src/content/docs/logs/reference/log-fields/account/gateway_dns.md index 313b3131a5159b2..0375ea60a182376 100644 --- a/src/content/docs/logs/reference/log-fields/account/gateway_dns.md +++ b/src/content/docs/logs/reference/log-fields/account/gateway_dns.md @@ -81,17 +81,17 @@ Type: `string` IP and port combo used to resolve the custom dns resolver query, if any. -## CustomResolverPolicyID +## CustomResolverPolicyID (deprecated) Type: `string` -Custom resolver policy UUID, if matched. +Custom resolver policy UUID, if matched. Deprecated by ResolverPolicyID. -## CustomResolverPolicyName +## CustomResolverPolicyName (deprecated) Type: `string` -Custom resolver policy name, if matched. +Custom resolver policy name, if matched. Deprecated by ResolverPolicyName. ## CustomResolverResponse @@ -165,6 +165,30 @@ Type: `array[string]` Name or names of category that the queried domains belongs to (for example, ['Photography', 'Weather']). +## InternalDNSFallbackStrategy + +Type: `string` + +The fallback strategy applied over the internal DNS response. Empty if no fallback strategy was applied. + +## InternalDNSRCode + +Type: `int` + +The return code sent back by the internal DNS service. + +## InternalDNSViewID + +Type: `string` + +The DNS internal view identifier that was sent to the internal DNS service. + +## InternalDNSZoneID + +Type: `string` + +The DNS zone identifier returned by the internal DNS service. + ## IsResponseCached Type: `bool` @@ -339,6 +363,18 @@ Type: `string` Result of the DNS query (for example, 'overrideForSafeSearch'). +## ResolverPolicyID + +Type: `string` + +Resolver policy UUID, if any matched. + +## ResolverPolicyName + +Type: `string` + +Resolver policy name, if any matched. + ## ResourceRecords Type: `array[object]` @@ -349,7 +385,7 @@ The rdata objects (for example, [{"type":"5","data":"dns-packet-placeholder..."} Type: `string` -String that represents the JSON array with the returned resource records (for example, "[{\"name\": \"example.com\", \"type\": \"CNAME\", \"class\": \"IN\", \"ttl\": 3600, \"rdata\": \"cname.example.com.\"}]"). +String that represents the JSON array with the returned resource records (for example, '[{"name": "example.com", "type": "CNAME", "class": "IN", "ttl": 3600, "rdata": "cname.example.com."}]'). ## SrcIP diff --git a/src/content/docs/logs/reference/log-fields/account/ssh_logs.md b/src/content/docs/logs/reference/log-fields/account/ssh_logs.md new file mode 100644 index 000000000000000..5be9a3471b08de7 --- /dev/null +++ b/src/content/docs/logs/reference/log-fields/account/ssh_logs.md @@ -0,0 +1,118 @@ +--- +# Code generator. DO NOT EDIT. + +title: SSH Logs +pcx_content_type: configuration +sidebar: + order: 21 +--- + +The descriptions below detail the fields available for `ssh_logs`. + +## AccountID + +Type: `string` + +Cloudflare account ID. + +## ClientAddress + +Type: `string` + +Source address of the SSH command. + +## Datetime + +Type: `int or string` + +Timestamp in UTC of when this message is being sent. + +## Error + +Type: `string` + +SSH error. Only used if an error occurred. + +## PTY + +Type: `string` + +Used by certain programs when running interactive shells to synchronize local with remote SSH terminal state. + +## Payload + +Type: `string` + +Captured request/response data, base64-encoded in asciinema .cast format. This includes the command associated with the "exec" program type. + +## ProgramFinishDatetime + +Type: `int or string` + +The date and time the specific SSH program was completed. This is empty until the program ends. + +## ProgramID + +Type: `string` + +SSH program ID, a single SSH session can have multiple programs running. + +## ProgramStartDatetime + +Type: `int or string` + +The date and time the specific SSH program started. + +## ProgramType + +Type: `string` + +The SSH program being run e.g. "shell": default user's shell on target machine, "exec": execute provided command (used with "cmd" below), "x11": an interactive graphical environment, "direct-tcpip": direct tunneling, "forwarded-tcpip": reverse tunneling + +## ServerAddress + +Type: `string` + +Destination address for the SSH command. + +## SessionFinishDatetime + +Type: `int or string` + +The date and time the SSH session was completed. This is empty until the session ends. + +## SessionID + +Type: `string` + +SSH session ID. + +## SessionStartDatetime + +Type: `int or string` + +The date and time the SSH session was created. + +## TargetID + +Type: `string` + +Identifier for which target is being accessed. + +## UserEmail + +Type: `string` + +User email address. + +## UserID + +Type: `string` + +Cloudflare user ID. + +## Username + +Type: `string` + +Principal user being accessed on SSH server's machine. Empty if error raised when establishing connection.