Skip to content

Commit 1813d63

Browse files
Merge pull request #1872 from tharinduwijewardane/PE_systemEvent
Add docs for system logs and alerts
2 parents 1978901 + 98160f3 commit 1813d63

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

en/developer-docs/docs/monitoring-and-insights/alerts-overview.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ Choreo supports the following types of alerts to help you monitor and manage you
1111

1212
- [Latency alerts](#latency-alerts)
1313
- [Traffic alerts](#traffic-alerts)
14-
- [Resource alerts](#resource-alerts)
14+
- [Usage alerts](#usage-alerts)
1515
- [Log alerts](#log-alerts)
1616
- [Build failure alerts](#build-failure-alerts)
1717
- [Status code alerts](#status-code-alerts)
18+
- [System alerts](#system-alerts)
1819

1920
### Latency Alerts
2021

@@ -39,16 +40,16 @@ Configurable parameters
3940
| Threshold | Requests per minute (e.g.: 200). |
4041
| Period | Monitoring window (e.g.: 5 minutes). |
4142

42-
### Resource Alerts
43+
### Usage Alerts
4344

44-
Resource alerts notify you when your component’s CPU or memory usage exceeds the defined thresholds. This ensures you can fix the resources allocations early to avoid performance issues or downtimes.
45+
Usage alerts notify you when your component’s CPU, memory or log volume exceeds the defined thresholds. This ensures you can fix the resources allocations early to avoid performance issues or downtimes.
4546

4647
Configurable parameters
4748

4849
| **Parameter** | **Description** |
4950
|---------------|---------------------------------------------------------------------------------|
50-
| Metric | CPU or Memory. |
51-
| Threshold | **mCPU** for CPU and **MiB** for Memory(e.g.: 1000). |
51+
| Metric | CPU, Memory or Log Volume. |
52+
| Threshold | **mCPU** for CPU, **MiB** for Memory and **MB** for Log Volume. |
5253
| Period | Duration the threshold must be exceeded (e.g.: 5 minutes). |
5354

5455
!!! Tip
@@ -86,6 +87,16 @@ Configurable parameters
8687
!!! note
8788
Status code alerts are only supported for API proxy component types.
8889

90+
### System Alerts
91+
92+
System alerts notify you when a system event which needs attention occurs. This is useful for monitoring the health of the system and taking corrective measures when necessary.
93+
94+
Configurable parameters
95+
96+
| **Parameter** | **Description** |
97+
|---------------|---------------------------------------------------------------------------------|
98+
| Event | System event to monitor (e.g.: Container Crash, Out of Memory). |
99+
89100
## Configure Alert
90101

91102
Follow these steps to configure an alert:

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@ Each gateway log entry displays the following details:
6464
- `componentVersion`: The version of the invoked component.
6565
- `envName`: The environment of the inbound request. For example, Development, Production, etc.
6666

67+
#### System logs
68+
69+
Each system log entry displays the following details:
70+
- `timestamp`: The time of the system event.
71+
- `componentVersion`: The version of the component.
72+
- `componentVersionId`: The identifier of the component’s version.
73+
- `reason`: The system event reason.
74+
- `logEntry`: The system event details.
75+
- `kind`: The kind of the k8s object related to the event.
76+
77+
6778
## Audit logs
6879

6980
Audit logs, also called audit trails, enhance security, ensure compliance, provide operational insights, and help manage risks.

0 commit comments

Comments
 (0)