Skip to content

NOISSUE - Fix alarm severity range and reports metrics type name #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dborovcanin merged 1 commit into from
Sep 2, 2026
Merged

NOISSUE - Fix alarm severity range and reports metrics type name #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/docs/dev-guide/services/alarms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ type Alarm struct {
| unit | string | Unit of the measurement value | ❌ |
| threshold | string | Threshold value set in the rule that triggered the alarm | ✅ |
| cause | string | Explanation of why the alarm was triggered | ✅ |
| severity | uint8 | Severity level of the alarm (e.g., 1 = low, 5 = critical) | ✅ |
| severity | uint8 | Severity level of the alarm, 0-100 (e.g., 10 = low, 90 = critical) | ✅ |
| assignee_id | string | ID of the user assigned to resolve the alarm | ❌ |
| created_at | time.Time | Timestamp when the alarm was created | ❌ |
| updated_at | time.Time | Timestamp when the alarm was last updated | ❌ |
Expand All @@ -87,7 +87,7 @@ The `status` field in the Alarm struct indicates the current state of the alarm.

### Severity Levels

The `severity` field indicates the importance of the alarm. The severity levels are user defined and can range from low to critical (e.g., 1 to 5).
The `severity` field indicates the importance of the alarm. It accepts a `uint8` from 0 to 100 (`ErrInvalidSeverity` is returned above that) — the scale within that range is otherwise up to you, e.g. 10 = low, 90 = critical.

## Alarm API Endpoints

Expand Down
4 changes: 2 additions & 2 deletions content/docs/dev-guide/services/reports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ type ReportConfig struct {
Description string
WorkspaceID string
Config *MetricConfig
Metrics []Metric
Metrics []ReqMetric
Email *EmailSetting // Email Notification settings
Schedule Schedule // Generation schedule
ReportTemplate ReportTemplate // Custom HTML template for PDF generation
Expand All @@ -61,7 +61,7 @@ type ReportConfig struct {
| Schedule | Schedule | Execution schedule configuration | ✅ |
| Config | MetricConfig | Data collection parameters | ✅ |
| Email | EmailSetting | Email distribution settings | Optional |
| Metrics | []Metric | List of metrics to include | ✅ |
| Metrics | []ReqMetric | List of metrics to include | ✅ |
| ReportTemplate| ReportTemplate| Custom HTML template for PDF generation | Optional |
| Status | Status | Enabled/Disabled state | ✅ |
| CreatedAt | time.Time | Creation timestamp | Auto |
Expand Down
4 changes: 2 additions & 2 deletions content/docs/user-guide/alarms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The alarm object includes the following fields:
| `unit` | Unit of the measurement value | ❌ |
| `threshold` | Threshold value set in the rule that triggered the alarm | ✅ |
| `cause` | Explanation of why the alarm was triggered | ✅ |
| `severity` | Severity level of the alarm (e.g., 1 = low, 5 = critical) | ✅ |
| `severity` | Severity level of the alarm, 0-100 (e.g., 10 = low, 90 = critical) | ✅ |
| `assignee_id` | ID of the user assigned to resolve the alarm | ❌ |
| `created_at` | Timestamp when the alarm was created | ❌ |
| `updated_at` | Timestamp when the alarm was last updated | ❌ |
Expand Down Expand Up @@ -202,7 +202,7 @@ func logicFunction() any {

:::info

Severity values range from 1 to 5, with 1 being the lowest and 5 the highest.
Severity values range from 0 to 100, with 0 being the lowest and 100 the highest. The scale is otherwise user-defined — pick whatever thresholds within that range make sense for your rules.

:::

Expand Down
Loading