You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en/developer-docs/docs/monitoring-and-insights/view-logs.md
+22-3Lines changed: 22 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ The log view also provides advanced filtering capabilities that allow you to eff
13
13
14
14
Choreo runtime logs provide insights into both project and component-level logs, covering application and gateway logs. These logs streamline the debugging process by centralizing diverse log sources.
15
15
16
-
In Choreo, any organization member can view runtime logs via the runtime logs page. Choreo allows you to apply filters based on parameters such as log level (error, warn, info, debug), log type (application, gateway), and environment (development, staging, production) to simplify the debugging process.
16
+
In Choreo, any organization member can view runtime logs via the runtime logs page. Choreo allows you to apply filters based on parameters such as log level (error, warn, info, debug), log type (application, gateway, system), and environment (development, staging, production) to simplify the debugging process.
17
17
18
18
To access runtime logs, follow the steps below:
19
19
@@ -24,6 +24,25 @@ To access runtime logs, follow the steps below:
The runtime logs interface provides powerful search capabilities to help you quickly locate specific log entries.
30
+
31
+
#### Text search
32
+
Type any text into the search box to locate log entries that contain the exact phrase. Searches are case-sensitive and will match partial strings within the log messages of Application, Gateway, and System logs.
33
+
34
+
#### Advanced search with regex
35
+
Use Lucene-compatible regex patterns to perform advanced search queries. Refer to the [OpenSearch regex syntax](https://docs.opensearch.org/latest/query-dsl/regex-syntax/#standard-regex-operators) for more details.
36
+
37
+
Pattern examples:
38
+
39
+
-`error.*timeout` : Find logs containing the phrase "error" followed by "timeout"
40
+
-`.*(GET|POST).*&.*500.*` : Find logs of GET or POST request methods with HTTP 500 status code
41
+
-`\"userId\":\"12345\"` : Find logs containing the userId "12345"
42
+
-`outOfMemory|OOM` : Find logs containing either "outOfMemory" or "OOM"
43
+
44
+

45
+
27
46
### Understand runtime logs
28
47
29
48
When you view component-level logs on the **Runtime Logs** page, you will see application, gateway and system logs.
@@ -70,9 +89,9 @@ Each system log entry displays the following details:
70
89
71
90
-`timestamp`: The time of the system event.
72
91
-`componentVersion`: The version of the component.
73
-
-`componentVersionId`: The identifier of the component’s version.
92
+
-`componentVersionId`: The identifier of the component version.
74
93
-`reason`: The system event reason.
75
-
-`logEntry`: The system event details.
94
+
-`logEntry`: System event details.
76
95
-`kind`: The kind of the k8s object related to the event.
Copy file name to clipboardExpand all lines: en/pe-docs/docs/observability/runtime-logs.md
+31-1Lines changed: 31 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Choreo runtime logs provide insights into both project and component-level logs, covering application and gateway logs. These logs streamline the debugging process by centralizing diverse log sources.
4
4
5
-
In Choreo, any organization member can view runtime logs via the runtime logs page. Choreo allows you to apply filters based on parameters such as log level (error, warn, info, debug), log type (application, gateway), and environment (development, staging, production) to simplify the debugging process.
5
+
In Choreo, any organization member can view runtime logs via the runtime logs page. Choreo allows you to apply filters based on parameters such as log level (error, warn, info, debug), log type (application, gateway, system), and environment (development, staging, production) to simplify the debugging process.
6
6
7
7
To access runtime logs, follow the steps below:
8
8
@@ -13,6 +13,25 @@ To access runtime logs, follow the steps below:
The runtime logs interface provides powerful search capabilities to help you quickly locate specific log entries.
19
+
20
+
#### Text search
21
+
Type any text into the search box to locate log entries that contain the exact phrase. Searches are case-sensitive and will match partial strings within the log messages of Application, Gateway, and System logs.
22
+
23
+
#### Advanced search with regex
24
+
Use Lucene-compatible regex patterns to perform advanced search queries. Refer to the [OpenSearch regex syntax](https://docs.opensearch.org/latest/query-dsl/regex-syntax/#standard-regex-operators) for more details.
25
+
26
+
Pattern examples:
27
+
28
+
-`error.*timeout` : Find logs containing the phrase "error" followed by "timeout"
29
+
-`.*(GET|POST).*&.*500.*` : Find logs of GET or POST request methods with HTTP 500 status code
30
+
-`\"userId\":\"12345\"` : Find logs containing the userId "12345"
31
+
-`outOfMemory|OOM` : Find logs containing either "outOfMemory" or "OOM"
32
+
33
+

34
+
16
35
### Understand runtime logs
17
36
18
37
When you view component-level logs on the **Runtime Logs** page, you will see both application and gateway logs.
@@ -52,3 +71,14 @@ Each gateway log entry displays the following details:
52
71
-`statusCode`: The HTTP status code returned to the client.
53
72
-`componentVersion`: The version of the invoked component.
54
73
-`envName`: The environment of the inbound request. For example, Development, Production, etc.
74
+
75
+
#### System logs
76
+
77
+
Each system log entry displays the following details:
78
+
79
+
-`timestamp`: The time of the system event.
80
+
-`componentVersion`: The version of the component.
81
+
-`componentVersionId`: The identifier of the component version.
82
+
-`reason`: The system event reason.
83
+
-`logEntry`: System event details.
84
+
-`kind`: The kind of the k8s object related to the event.
0 commit comments