Skip to content

Commit f59a120

Browse files
authored
[Logs] Update Log fields (#19293)
This updates Log fields. They are synced from internal `entities` repo's fields templates. Co-authored-by: Sohei Gallagher <[email protected]>
1 parent aa820a8 commit f59a120

File tree

1 file changed

+14
-14
lines changed
  • src/content/docs/logs/reference/log-fields/account

1 file changed

+14
-14
lines changed

src/content/docs/logs/reference/log-fields/account/ssh_logs.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,67 +19,67 @@ Cloudflare account ID.
1919

2020
Type: `string`
2121

22-
Source address of the SSH command.
22+
The source address of the SSH command.
2323

2424
## Datetime
2525

2626
Type: `int or string`
2727

28-
Timestamp in UTC of when this message is being sent.
28+
The timestamp in UTC of when this message is being sent.
2929

3030
## Error
3131

3232
Type: `string`
3333

34-
SSH error. Only used if an error occurred.
34+
An SSH error. Only used if an error has occurred.
3535

3636
## PTY
3737

3838
Type: `string`
3939

40-
Used by certain programs when running interactive shells to synchronize local with remote SSH terminal state.
40+
This is used by certain programs types to synchronize local and remote SSH terminal state.
4141

4242
## Payload
4343

4444
Type: `string`
4545

46-
Captured request/response data, base64-encoded in asciinema .cast format. This includes the command associated with the "exec" program type.
46+
The captured request/response data, in asciicast v2 format. This includes the command associated with the 'exec' program type.
4747

4848
## ProgramFinishDatetime
4949

5050
Type: `int or string`
5151

52-
The date and time the specific SSH program was completed. This is empty until the program ends.
52+
The timestamp in UTC of the SSH program termination. This is empty until the program ends.
5353

5454
## ProgramID
5555

5656
Type: `string`
5757

58-
SSH program ID, a single SSH session can have multiple programs running.
58+
The SSH program ID. A single SSH session can have multiple programs running.
5959

6060
## ProgramStartDatetime
6161

6262
Type: `int or string`
6363

64-
The date and time the specific SSH program started.
64+
The timestamp in UTC of the SSH program creation.
6565

6666
## ProgramType
6767

6868
Type: `string`
6969

70-
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
70+
The SSH program being run. The options are 'shell': opens an interactive terminal, 'exec': execute a single specified command, 'x11': is for an interactive graphical environment, 'direct-tcpip': direct tunneling, 'forwarded-tcpip': reverse tunneling.
7171

7272
## ServerAddress
7373

7474
Type: `string`
7575

76-
Destination address for the SSH command.
76+
The destination address for the SSH session.
7777

7878
## SessionFinishDatetime
7979

8080
Type: `int or string`
8181

82-
The date and time the SSH session was completed. This is empty until the session ends.
82+
The timestamp in UTC of the SSH session termination. This is empty until the session ends.
8383

8484
## SessionID
8585

@@ -91,13 +91,13 @@ SSH session ID.
9191

9292
Type: `int or string`
9393

94-
The date and time the SSH session was created.
94+
The timestamp in UTC of the SSH session creation.
9595

9696
## TargetID
9797

9898
Type: `string`
9999

100-
Identifier for which target is being accessed.
100+
The identifier of the target being accessed.
101101

102102
## UserEmail
103103

@@ -115,4 +115,4 @@ Cloudflare user ID.
115115

116116
Type: `string`
117117

118-
Principal user being accessed on SSH server's machine. Empty if error raised when establishing connection.
118+
The principal user being accessed on SSH server's machine. This will be empty if an error was thrown when establishing the connection.

0 commit comments

Comments
 (0)