Skip to content

Commit 6ea8982

Browse files
authored
Merge pull request #1874 from akila-i/log-regex
Add runtime logs regex search docs and add system logs in PE docs
2 parents 5de25a4 + fcb36dc commit 6ea8982

File tree

4 files changed

+53
-4
lines changed

4 files changed

+53
-4
lines changed
711 KB
Loading

en/developer-docs/docs/monitoring-and-insights/view-logs.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The log view also provides advanced filtering capabilities that allow you to eff
1313

1414
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.
1515

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.
1717

1818
To access runtime logs, follow the steps below:
1919

@@ -24,6 +24,25 @@ To access runtime logs, follow the steps below:
2424

2525
![Runtime logs](../assets/img/monitoring-and-insights/view-logs/runtime-logs.png)
2626

27+
### Searching through runtime logs
28+
29+
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+
![Search and filter interface](../assets/img/monitoring-and-insights/view-logs/search-regex.png)
45+
2746
### Understand runtime logs
2847

2948
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:
7089

7190
- `timestamp`: The time of the system event.
7291
- `componentVersion`: The version of the component.
73-
- `componentVersionId`: The identifier of the component’s version.
92+
- `componentVersionId`: The identifier of the component version.
7493
- `reason`: The system event reason.
75-
- `logEntry`: The system event details.
94+
- `logEntry`: System event details.
7695
- `kind`: The kind of the k8s object related to the event.
7796

7897

714 KB
Loading

en/pe-docs/docs/observability/runtime-logs.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

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.
66

77
To access runtime logs, follow the steps below:
88

@@ -13,6 +13,25 @@ To access runtime logs, follow the steps below:
1313

1414
![Runtime logs](../assets/img/monitoring-and-insights/view-logs/runtime-logs.png)
1515

16+
### Searching through runtime logs
17+
18+
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+
![Search and filter interface](../assets/img/monitoring-and-insights/view-logs/search-regex.png)
34+
1635
### Understand runtime logs
1736

1837
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:
5271
- `statusCode`: The HTTP status code returned to the client.
5372
- `componentVersion`: The version of the invoked component.
5473
- `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

Comments
 (0)