diff --git a/opsimate-docs/docs/alerts/alert-management.md b/opsimate-docs/docs/alerts/alert-management.md index 8df156f..ca4b91d 100644 --- a/opsimate-docs/docs/alerts/alert-management.md +++ b/opsimate-docs/docs/alerts/alert-management.md @@ -43,6 +43,15 @@ Use **group by** to organize alerts based on what matters to you: - Group by **nested fields** inside the alert payload for more advanced views - Quickly spot patterns, noisy sources, or services with repeated issues +### Ownership Management + +You can assign ownership to alerts to track responsibility and ensure timely resolution by adding the owner field to the column configuration. + +- Assign users to specific alerts for clear accountability +- Track ownership history and handovers for better collaboration +- Set escalation rules based on ownership assignments for timely resolution +- Filter alerts by ownership status for better accountability + ### Alert Details Sidebar Click any alert row to open a **details sidebar** on the right: @@ -50,5 +59,6 @@ Click any alert row to open a **details sidebar** on the right: - See full alert information, including labels, payload, and timestamps - Follow a direct **link to the source** alert in the original monitoring tool - Use a **runbook link** to jump straight to the documentation or procedure for handling that alert +- Set and view ownership information for better accountability Each alert shows its source integration for easy traceability back to the original monitoring system. diff --git a/opsimate-docs/docs/dashboards/overview.md b/opsimate-docs/docs/dashboards/overview.md deleted file mode 100644 index cb94f42..0000000 --- a/opsimate-docs/docs/dashboards/overview.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Dashboard Overview - -The main interface for monitoring and controlling your services. - -
- OpsiMate Dashboard -

OpsiMate main dashboard showing service overview and controls

-
- -## Service Control - -Control services directly from the dashboard interface. - -
-
-

Start/Stop/Restart Services

-

Control service lifecycle with one-click actions

-
-
-

Control Services

-

Control services with one-click actions

-
-
- -
-
-

One Ring to rule them all

-

Intagrate With all your tools related to your services

-
-
-

Monitor Status

-

Real-time service health and performance metrics and logs

-
-
- -## Service Filtering - -Filter and organize services for better visibility. - -### Search Functionality -- **Quick Search**: Find services by name or description -- **Saved Searches**: Store frequently used filter combinations diff --git a/opsimate-docs/docs/dashboards/saved-dashboards.md b/opsimate-docs/docs/dashboards/saved-dashboards.md new file mode 100644 index 0000000..6e8238d --- /dev/null +++ b/opsimate-docs/docs/dashboards/saved-dashboards.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 4 +--- + +# Saved Dashboards + +Saved Dashboards lets you store and reuse a dashboard configuration so you can quickly return to the same view. + +A saved dashboard includes: +- **Name** +- **Description** +- **Saved filters/search** +- **Table columns** (the selected/visible columns) +- **Tags** (for organization and filtering) + +
+ Saved Dashboards +

Saved Dashboards page with favorites, tags, search, and actions

+
+ + +### How to Save a Dashboard + +1. Click **New Dashboard** in the top-right corner. +2. You will be redirected back to the **Alerts** screen. +3. From there, you can filter or modify the search to shape your dashboard. +4. Update the dashboard name. +5. Save the dashboard. + +Once the process is complete, you will be able to see your saved dashboard. diff --git a/opsimate-docs/docs/dashboards/saving-views.md b/opsimate-docs/docs/dashboards/saving-views.md deleted file mode 100644 index bce9075..0000000 --- a/opsimate-docs/docs/dashboards/saving-views.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Saving Views - -Save and manage filtered service views for quick access to specific service groups. - -## View Management - -### Creating Views -1. **Configure Filters**: Set up your desired service filters -2. **Save View**: Click "Save Current View" and provide a name diff --git a/opsimate-docs/docs/dashboards/service-menu.md b/opsimate-docs/docs/dashboards/service-menu.md deleted file mode 100644 index b5c249b..0000000 --- a/opsimate-docs/docs/dashboards/service-menu.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Service Menu - -Access service-specific options and controls through the right-side menu. - -## Accessing the Service Menu - -Click on any service in the dashboard to open the service-specific menu panel. - -
- Service Menu Sidebar -

Service menu sidebar with detailed controls and information

-
- -
-
-

Service Details

-

View comprehensive service information and status

-
-
-

Quick Actions

-

Start, stop, restart, and manage services

-
-
- -## Menu Options - -### Service Control -- **Start Service**: Activate inactive services -- **Stop Service**: Gracefully stop running services -- **Restart Service**: Restart services to resolve issues -- **Force Stop**: Emergency service termination - -### Monitoring & Alerts -- **Configure Alerts**: Set up service-specific notifications -- **View Metrics**: Access detailed performance data -- **Health Checks**: Configure and view service health status -- **Threshold Settings**: Set resource usage alerts - -### Logs & Diagnostics -- **View Logs**: Access real-time service logs -- **Download Logs**: Export log files for analysis -- **Log Filtering**: Search and filter log entries -- **Error Analysis**: Identify and analyze service errors - -### Service Configuration -- **Edit Settings**: Modify service configuration -- **Environment Variables**: Manage service environment -- **Resource Limits**: Set CPU and memory constraints -- **Dependency Management**: Configure service dependencies - -### Tags & Organization -- **Add Tags**: Label services for better organization -- **Edit Description**: Update service descriptions -- **Group Assignment**: Assign services to logical groups -- **Priority Settings**: Set service monitoring priority - -## Context-Sensitive Options - -Menu options adapt based on service type and current status. - -### For Running Services -- Stop and restart options available -- Real-time metrics and logs accessible -- Performance monitoring active - -### For Stopped Services -- Start option prominently displayed -- Configuration editing enabled -- Historical data available - -### Service Type Specific -- **Systemd Services**: Systemctl command options -- **Docker Containers**: Container management commands -- **Kubernetes Pods**: Kubectl operations and namespace management diff --git a/opsimate-docs/sidebars.js b/opsimate-docs/sidebars.js index f550aaf..85f87b3 100644 --- a/opsimate-docs/sidebars.js +++ b/opsimate-docs/sidebars.js @@ -26,35 +26,7 @@ const sidebars = { 'getting-started/system-requirements', ], }, - // { - // type: 'category', - // label: 'Providers & Services', - // collapsed: true, - // items: [ - // 'providers-services/overview', - // { - // type: 'category', - // label: 'Providers', - // collapsed: true, - // items: [ - // 'providers-services/providers/add-provider', - // 'providers-services/providers/server-provider', - // 'providers-services/providers/kubernetes-provider', - // ], - // }, - // { - // type: 'category', - // label: 'Services', - // collapsed: true, - // items: [ - // 'providers-services/services/add-services', - // 'providers-services/services/container-services', - // 'providers-services/services/systemd-services', - // 'providers-services/services/kubernetes-pods', - // ], - // }, - // ], - // }, + { type: 'category', label: 'Integrations', @@ -67,19 +39,17 @@ const sidebars = { 'integrations/datadog', ], }, - // { - // type: 'category', - // label: 'Dashboard', - // collapsed: true, - // items: [ - // 'dashboards/overview', - // 'dashboards/service-menu', - // 'dashboards/saving-views', - // ], - // }, { type: 'category', - label: 'Alerts Dashboard', + label: 'Dashboard', + collapsed: true, + items: [ + 'dashboards/saved-dashboards', + ], + }, + { + type: 'category', + label: 'Alerts', collapsed: true, items: ['alerts/adding-alerts', 'alerts/alert-management', 'alerts/archived-alerts', 'alerts/tv-mode'], }, diff --git a/opsimate-docs/static/img/saved-dashboards.png b/opsimate-docs/static/img/saved-dashboards.png new file mode 100644 index 0000000..e1612a7 Binary files /dev/null and b/opsimate-docs/static/img/saved-dashboards.png differ