How-to guides
Users can monitor resources created on the Samsung Cloud Platform through ServiceWatch.
Using the Dashboard
You can monitor resources on the ServiceWatch dashboard detail screen.
information
- To use the dashboard, you must first create a dashboard and register monitoring metrics as widgets.
- Please refer to Creating a Dashboard for detailed information on dashboard creation.
To monitor resources with the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- On the Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
- Dashboard Details page, select the monitoring period and time zone, then monitor resources using the widget.
| Category | Detailed description |
|---|
| Dashboard name | Dashboard name- click to select another dashboard
|
| Period setting area | Period selection applied to widgets in the dashboard- Metric queries can be set from now up to a maximum of 455 days
|
| Time Zone Settings Section | Select the time zone applied to the period setting |
| Reset button | Reset all actions and settings made on the dashboard detail screen. |
| Refresh Settings Area | Select refresh interval for widget information- Refresh button displays information anew based on the current time
- Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
|
| Edit | Edit dashboard information- When the Edit button is clicked, navigate to the Dashboard Edit page
- For detailed information about dashboard editing, see 대시보드 관리하기
|
| More | Display additional tasks for managing the dashboard |
| Alert Status | Show the number of active alerts linked to recommended metrics on the service dashboard, displayed by stage- When the View All Alert Policies button is clicked, navigate to the Alert Policy List page
- When the Expand button is clicked, the content is provided as widgets (up to 12)
- For detailed information on widget management, refer to 위젯 관리하기
- View Alert Policy: navigate to the Alert Policy Details page for the corresponding metric
|
| Dashboard status | Display metric widgets for monitoring each resource- Click the Widget Expand View button to view detailed information about the metric
- Click the More button to manage widgets
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking a resource name shown in the legend displays detailed information about that resource in a popup
|
Table. Dashboard detailed items
Reference
- Click the More > View Metrics button at the top right of the widget to view metric information for that widget on the Metrics page.
- For detailed information about the Metric page, please refer to Metric View.
Setting dashboard favorites
You can bookmark frequently used dashboards and easily navigate to the dashboard from the ServiceWatch Service Home page.
To bookmark the dashboard, follow these steps.
- All Services > Management > ServiceWatch menu, click. 1. Go to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- Dashboard List page, check the favorite icon of the dashboard you want to bookmark. Click the dashboard to view its details. 3. Navigate to the Dashboard Details page.
- Bookmarked dashboards are added to the bottom of the Dashboard > Dashboard Favorites menu and the Dashboard Favorites section on the Service Home page.
Widget Details
You can enlarge widgets within the dashboard to view them individually.
To enlarge and view an individual widget, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Go to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. 2. Navigate to the Dashboard List page.
- Dashboard List page, click the dashboard for the resource you want to monitor. 3. Navigate to the Dashboard Details page.
- On the Dashboard Details page, click the Widget Zoom button for the widget you wish to enlarge. 4. The Metric Details popup opens for this widget.
| Category | Detailed description |
|---|
| Widget name | Display widget name |
| Period setting area | Period selection applied to the widget- Metric lookup can be set from now up to a maximum of 455 days
|
| Time Zone Settings Section | Select the time zone applied to the period setting |
| Reset button | Reset all actions and settings made on the dashboard detail screen. |
| Statistics | Select statistical basis for the metric displayed in the widget- Click the statistical basis to select: average, minimum, maximum, sum
|
| Aggregation Period Setting Area | Select aggregation period for widget information- Click the aggregation period to choose the desired interval: 1 minute, 5 minutes, 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
|
| Refresh Settings Area | Select refresh interval for widget information- Refresh button displays information anew based on the current time
- Click the refresh interval to select the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
|
| Chart area | Display monitoring results as a chart- When the mouse cursor is placed over the graph or legend area, a popup shows the time, data value, and metric data for that point
- You can drag the graph area to zoom into the selected region
- Clicking a resource name displayed in the legend opens a popup with the alarm status for that resource
|
Table. Detailed indicator items
Check alarm history
You can view the alert history for metrics registered on the ServiceWatch dashboard.
To view the alarm history, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Service Home Go to the page.
- On the Service Home page, click the Alarm > Alarm History menu. 2. Go to the Alarm History page.
- Check the alarm history on the Alarm History page.
| Category | Detailed description |
|---|
| Alert filter and search area | Filter or search alarm history- All alarm statuses: Filter by selecting an alarm status
- Enter the alarm policy name in the search field to search
- Advanced search: Search by entering the alarm policy name, alarm status, or change timestamp
|
| Alert Policy Name | Alert policy name- Click the alert policy name to view detailed information of that alert policy
|
| Condition | Alarm trigger conditions and total occurrence time- Stage display according to severity: High, Middle, Low
|
| Category | Distinguish alarm creation and alarm status change information |
| Alarm status | Current alert status- Normal: when the metric does not meet the configured condition
- Insulfficient data: when the metric data cannot be retrieved (missing, nonexistent, not arrived)
- Alert: when the metric meets the configured condition
|
| Alert level | When the alarm status is Alert, display the alarm level |
Table. Alarm History Items
Reference
- You can view the recent alarm status through Copilot.
- ‘Alarm name’ or ‘ID’ alarm query: You can view the alarm status widget for the past 3 hours. * When you click the Alert Policy Shortcut button, you will be taken to the detail page of that alert policy.
- ‘Show recent alerts’: You can view up to 5 of the most recent alerts. * Click the Alert Policy List Shortcut button to go to the alert policy list page.
- You can create and manage new alert policies. * For detailed information about the alert policy, please refer to View alert policy.
Monitoring Metrics
You can view and monitor the metrics available in ServiceWatch.
Compare by indicator
You can select one or multiple metrics and resources to monitor.
To compare and monitor by metric, follow these steps.
All Services > Management > ServiceWatch menu, click. 1. Navigate to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
On the Metrics page, in metric view mode, click Metric Comparison.
Select the metric to monitor from the metric list on the Metric page. 4. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
| Category | Detailed description |
|---|
| Indicator List Area | List of metrics that can be monitored in ServiceWatch- Click the + button in front of the namespace or dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
|
| Search filter area | After setting the search items to filter, click the Apply Filter button to filter the metric list- Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Search by entering the exact metric name
- Resource Name: Search by entering the exact resource name
- Resource ID: Search by entering the exact resource ID
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
|
Table. Indicator list items
Check the monitoring chart in the Selected metric area.
| Category | Detailed description |
|---|
| Period setting area | Select the period applied to the chart- Indicator lookup can be set from now up to a maximum of 455 days
|
| Time Zone Settings Area | Select the time zone applied to the chart |
| Reset button | Reset all modifications and settings made on the chart |
| Refresh Settings Area | Select chart refresh interval- Refresh button displays information anew based on the current time
- Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
|
| More | Display additional tasks for managing charts |
| graph area | Data graph collected during the period applied to the chart- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking a label name displayed in the legend shows detailed information about that legend in a popup
|
| Table area | View and edit labels, statistics, and aggregation periods for each legend- Legend: Color per legend
- Click a legend color to change it to another color
- Label: Displays the namespace, resource name, and metric name of the selected metric
- Click the legend name to edit it
- Enter using letters, numbers, and special characters, between 3 and 255 characters
- Statistics: Choose how to aggregate metric data
- Select from Average (default), Minimum, Maximum, Sum
- Aggregation period: Choose the time unit for aggregating metric values
- Select from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
- More: Delete a legend or create an alert policy for the legend
|
Table. Indicator comparison monitoring chart items
Reference
- The statistical method is as follows.
- Total: sum of all data point values collected during the period
- Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period.
- Minimum: the lowest value observed during the specified period
- Maximum: the highest value observed during the specified period
- For a detailed description of the metric, refer to Metric Overview.
Compare by Date
You can monitor by comparing a metric and a resource across dates or time periods.
To compare and monitor by date or period, follow these steps.
All Services > Management > ServiceWatch menu, click it. 1. Navigate to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
On the Metrics page, in view mode, click Date Comparison.
Select the metric to monitor from the metric list on the Metric page. 4. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
| Category | Detailed description |
|---|
| Indicator List Area | List of metrics that can be monitored in ServiceWatch- Click the + button in front of the namespace or dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the selected metric area
|
| Search filter area | After setting the search items to filter, click the Apply Filter button to filter the metric list- Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Search by entering the exact metric name
- Resource Name: Search by entering the exact resource name
- Resource ID: Search by entering the exact resource ID
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
|
Table. Indicator list items
Check the monitoring chart in the selected metric area.
| Category | Detailed description |
|---|
| Date comparison / period comparison | Select criteria for comparing indicators- Date comparison: Compare by selecting a specific date
- Period comparison: Compare by selecting a specific period
|
| Date and period setting area | Select date or period to compare- Date comparison: Select the date to view on the chart
- Period comparison: Select the period to view on the chart
- You can select up to four dates or periods within a maximum of 455 days from today
|
| Time Zone Settings Section | Select the time zone applied to the chart |
| Reset button | Reset all manipulations and settings made on the chart |
| Refresh Settings Area | Select chart refresh interval- Refresh button updates the information based on the current time
- Click the refresh interval to select the desired interval: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
|
| More | Display additional tasks for managing charts |
| graph area | Data graph collected during the period applied to the chart- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking the date or period shown in the legend displays detailed information about that legend in a popup
|
| Table area | View and edit labels, statistics, and aggregation periods for each legend- Legend: Color per legend
- Click a legend color to change it to another color
- Period: Period applied to the chart
- Metric: Displays the namespace, resource name, and metric name of the selected metric
- Statistics: Choose how to aggregate metric data
- Average(default), Minimum, Maximum, Sum can be selected.
- Refer to the green icon displayed to the right of a meaningful metric in the relevant metric
- Aggregation Period: Select the aggregation period unit for metric values
- 1 minute, 5 minutes(default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day can be selected
- More: Delete a legend or create an alert policy for a legend
|
Table. Date comparison monitoring chart items
Reference
- The statistical method is as follows.
- Total: sum of all data point values collected during the period
- Average: the value obtained by dividing the sum over the specified period by the number of data pointers during that period
- Minimum: the lowest value observed during the specified period
- Maximum: the highest value observed during the specified period
- For detailed explanations of the metrics, refer to the Metric Overview.
Log Monitoring
You can monitor logs collected from the Samsung Cloud Platform service.
information
To view log monitoring data, you must first create a
log group and
log stream. For detailed information about log groups, please refer to
Log Monitoring.
To view the log monitoring data, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. 2. Navigate to the Log Group List page.
- On the Log Group List page, click the log group name to view its details. 3. Navigate to the Log Group Details page.
- On the Log Group Details page, click the Log Stream tab. 4. Log Stream list is displayed.
- log stream Click the log stream name in the list to view detailed information. 5. Navigate to the Log Stream Details page.
- Click the All Log Streams View button at the top of the log stream list to go to the All Log Streams Details page.
| Category | Detailed description |
|---|
| Excel download | Log stream history can be downloaded as an Excel file |
| Timestamp list | Message list by timestamp- Select period, user time zone, can filter using message input
|
Table. Log group details - Log stream detail items
Receive event notifications
You can create a system event rule for changes to resources generated in Samsung Cloud Platform and receive them as notifications.
guide
To receive event notifications, you must first create an
event rule. For detailed information on creating event rules, see
Create Event Rule.
Installing ServiceWatch Agent
You can install the ServiceWatch Agent to collect custom metrics and logs from the monitoring target.
Caution
Collecting metrics through the ServiceWatch Agent is classified as custom metrics, and unlike the default metrics collected from each service, it incurs charges, so you should be careful not to configure unnecessary metric collection. Make sure to configure it so that only the metrics that need to be collected are collected.
To install the ServiceWatch Agent, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Agent Setup & Guideline button. 2. Agent Setup & Guideline A popup window opens.
- Agent Setup & Guideline Copy the installation file URL from the popup window and go to that address. 3. Agent, manager, and configuration files can be downloaded.
Reference
Collecting custom metrics and logs via the ServiceWatch Agent is currently available only on Samsung Cloud Platform For Enterprise. It will also be available in other offerings in the future.
1 - Managing Dashboards and Widgets
In the Samsung Cloud Platform Console, you can create and manage dashboards to monitor the resources of the services you are using.
Create Dashboard
You can create a ServiceWatch dashboard.
Creating a dashboard by adding individual widgets
To create a dashboard, follow these steps.
All Services > Management > ServiceWatch menu, click it. You will be taken to the Service Home page.
Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Please enter the dashboard name.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
Add a widget to configure the dashboard. A popup window appropriate to the widget addition method will open.
- Add Individual Widget: You can add a single widget that combines metrics and resources. Clicking the button opens the Add Individual Widget popup.
| Category | Required status | Detailed description |
|---|
| Indicator classification | Selection | In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list |
| Indicator List Area | Required | List of metrics that can be monitored in ServiceWatch- Click the + button in front of the namespace and dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
|
| Search filter area | - | After setting the search items to filter, click the Apply Filter button to filter the metric list- Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Enter the exact metric name to search
- Resource Name: Enter the exact resource name to search
- Resource ID: Enter the exact resource ID to search
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
|
| Selected metric area | - | Monitoring chart for the selected metric in the metric list area- Data graph collected during the period applied to the chart
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking the resource name shown in the legend displays detailed information about that resource in a popup
- Item values in the table area within the chart can be edited
- Label: Enter the legend name using English letters, numbers, or special characters, between 3 ~ 255 characters
- Statistics: Choose the method for aggregating metric data
- Options: average (default), minimum, maximum, sum
- Aggregation period: Select the aggregation period unit for metric values
- Options: 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours
- Delete: Remove the legend
|
Table. Individual widget additional items
Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.
Click the Confirm button. Dashboard creation is complete.
Creating a dashboard by adding multiple widgets
To create a dashboard, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Enter the name of the dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.
- Add Multiple Widgets: Select the desired resources by metric unit and add multiple widgets at once. Clicking the button opens the Add Multiple Widgets popup window.
| Category | Required or not | Detailed description |
|---|
| Indicator classification | Select | In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list |
| Indicator selection area | Required | Select the namespace and resources to add- Click the + button in front of the namespace and resources to view the list of sub-resources and metrics
- When you check the metrics to add to the widget from the metric list, the Selected Metrics and Selected Resources sections are displayed
- Multiple metrics can be selected
|
| Selection indicator | Required | Display the list of selected metrics from the namespace and resource list- When a metric is clicked, the Selected Resources area shows the list of resources included in that metric
|
| Selected resource | Required | Selected Indicator list, add resources to the selected indicator- After clicking the Select button, choose resources that can be added to the indicator, allowing up to five additions
- Resources must be added for all indicators in the Selected Indicator list
|
| Statistics | Required | Select the statistical basis for the indicator value- You can choose from average (default), minimum, maximum, or sum
|
| Aggregation period | Required | Select the aggregation period unit for metric values- Choose from 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, or 12 hours
|
Table: Additional items for multiple widgets
Click the Complete button on the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will appear.
Click the Confirm button. The dashboard has been created.
Create a dashboard by loading a dashboard
To create a dashboard, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
On the Dashboard List page, click the Create Dashboard button.
Enter the name of the dashboard.
- Enter the dashboard name using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters. - You cannot enter a name that is already in use on the service dashboard.
Add a widget to configure the dashboard. A corresponding popup window will open according to the widget addition method.
- Dashboard Load: You can load widgets from dashboards registered in ServiceWatch. When you click the button, the Dashboard Load popup opens.
| Category | Required | Detailed description |
|---|
| Dashboard | Required | Display the list of dashboards registered in ServiceWatch- When a dashboard is selected, the widgets applied to the dashboard are displayed in the preview area
|
| Preview | Required | Display widgets applied to the selected dashboard from the dashboard list- Check the widget name to select widgets to add to the dashboard to be created
- If you check the Select All item, all metrics of that dashboard are selected
|
Table. Load Dashboard Items
Click the Complete button in the widget addition popup. The widget will be added to the dashboard on the dashboard creation page.
After confirming the added widget, click the Create button. A popup indicating dashboard creation will open.
Click the Confirm button. Dashboard creation is complete.
Check the dashboard
You can view the information of the selected dashboard on the Dashboard List page.
To view the dashboard, follow the steps below.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
| Category | Detailed description |
|---|
| Dashboard name | Dashboard name- User dashboards are the dashboard names set by the user. Service dashboards are the Samsung Cloud Platform service name that matches the service namespace
|
| Dashboard Category | Dashboard classification- User: Dashboard created directly by the user
- Service: Dashboard automatically composed of pre-built key metrics for each service
|
| Modification date and time | Dashboard modification timestamp |
| Creation date and time | Dashboard creation date and time |
| Favorites | If bookmarked, it is displayed in yellow- Click the star icon to set or remove a bookmark
|
Table. Dashboard list items
- On the Dashboard List page, click the dashboard whose details you want to view. You will be taken to the Dashboard Detail page.
| Category | Detailed description |
|---|
| Dashboard name | Display the dashboard name- Click the name to select another dashboard
|
| Period setting area | Period selection applied to widgets in the dashboard- Metric queries can be set from now up to a maximum of 455 days
|
| Time zone setting area | Select the time zone applied to the period setting |
| Reset button | Reset all actions and settings made on the dashboard detail screen |
| Refresh Settings Area | Select refresh interval for widget information- Refresh button updates the information based on the current time
- Click the refresh interval to choose the desired period: Off, 10 seconds, 1 minute, 2 minutes, 5 minutes, 15 minutes
|
| Edit | You can edit the dashboard name or manage widgets- When you click the Edit button, you are taken to the Dashboard Edit page
- For more details on editing the dashboard, see 대시보드 수정하기
|
| More | Display additional tasks for managing the dashboard- Dashboard duplication and deletion, view details, view source are possible
|
| Widget area | Display widgets for monitoring each resource- You can manage the widget by clicking the More button at the top right of the widget
- You can edit, duplicate, download files, view metrics, and view source of the widget
|
Table. Dashboard detailed items
Dashboard Management
Dashboard Details page allows you to edit or manage dashboard information and widgets.
Edit Dashboard
You can modify the dashboard name and change the widget configuration.
Information
The service dashboard cannot be edited.
To modify the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Click the Edit button at the top right of the Dashboard Details page. You will be taken to the Dashboard Edit page.
- After modifying the dashboard’s information or widgets, click the Save button.
| Category | Detailed description |
|---|
| Dashboard name | Dashboard name cannot be edited- Enter within 34 characters using English letters, numbers, and special characters (
-_)
- Dashboard names that are currently in use cannot be used
|
| Widget Name | Widget name can be edited- English letters, numbers, spaces, special characters(
-_.\
|
| Widget Management | When you hover the mouse over a widget, a management button appears on the right side of the widget border- Edit: Widget Edit popup allows you to modify the widget’s metrics and resources
- For details on widget editing, see the Individual Widget Edit in 위젯 관리하기
- Duplicate: Duplicate the current widget and add it to the dashboard
- Delete: Remove the current widget from the dashboard
- Expand: Display the current widget with an expanded size
- Collapse: If the widget is expanded, clicking again reduces its size
|
| Add widget | Add a new widget to the dashboard- Add individual widget: Add a single widget that combines metrics and resources
- Add multiple widgets: Select desired resources per metric to add multiple widgets at once
- Load dashboard: Load and add widgets from another dashboard
|
Table. Dashboard edit items
View detailed dashboard information
You can view detailed information about the dashboard.
To view detailed information of the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Dashboard Details page’s top right corner has a More > Details button. Click the button. The Dashboard Details popup opens.
| Category | Detailed description |
|---|
| Dashboard name | Dashboard name |
| Dashboard Category | Dashboard usage classification- User: dashboard created directly by the user
- Service: dashboard composed of automatically pre-built key metrics for each service
|
| Service | service name |
| Resource Type | dashboard |
| SRN | Unique resource ID in Samsung Cloud Platform- In ServiceWatch, it refers to the dashboard’s SRN
|
| Resource name | Resource Name- In ServiceWatch, the meaning of the dashboard name
|
| Resource ID | Unique resource ID in the service |
| Constructor | User who created the dashboard |
| Creation date and time | Dashboard creation date and time |
| Editor | User who edited the dashboard information |
| Modification date and time | Dashboard information modification timestamp |
Table. Dashboard Details - Detail Information Popup Items
Reference
When sorting dashboard names in the dashboard list, follow the sorting rules below.
- Whitespace and control characters
- Some special characters (
!"#$%&’()*+,-./ ) - Numbers (
0–9) - Some special characters (
; < = > ? @ ) - English (
A–Z, a–z, case-insensitive) - Remaining special characters (
[\]^_`) - Other characters
Check the dashboard source code
You can view the dashboard’s source code.
To view the source code of the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Click the Dashboard > Dashboard List menu on the Service Home page. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
- Dashboard Details on the top right of the page, click the More > View Source button. The Dashboard View Source popup opens.
| Category | Detailed description |
|---|
| Source information | Display the dashboard source code in JSON format |
| Copy code | Copy the source code to the clipboard |
Table. Dashboard Details - Dashboard Source View Popup Items
Duplicate Dashboard
You can duplicate a widget from the current dashboard and add it to another dashboard.
Information
User permission is required to duplicate the dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To duplicate the dashboard, follow these steps.
All Services > Management > ServiceWatch menu, click it. You will be taken to the Service Home page.
On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Details page.
Click the More > Duplicate button at the top right of the Dashboard Details page. The Dashboard Duplicate popup opens.
After selecting the dashboard duplication method, enter the required information. The required information varies depending on the duplication method.
| Category | Required | Detailed description |
|---|
| Replication target | - | Name of the dashboard to duplicate |
| Cloning method | Required | After duplicating the dashboard widget, select the dashboard to add it to- New Dashboard: Create a new dashboard and generate it by duplicating the current dashboard’s widget
- Existing Dashboard: Duplicate the current dashboard’s widget and add it to an existing dashboard
|
| Dashboard name | Required | Enter the name of the new dashboard- Displayed when the duplication method is set to New Dashboard
- Enter using English letters, numbers, and special characters (
-_) within 3 to 40 characters
|
| Select Dashboard | Required | Select the dashboard to which the duplicated widget will be added from the existing dashboards- Displayed when the duplication method is selected as Existing dashboard
|
Table. Dashboard clone items
After entering the required information, click the Complete button. A popup notifying that the dashboard is being duplicated will appear.
Click the Confirm button on the popup window. The dashboard duplication task is complete.
Reference
You can duplicate a service dashboard to add widgets to a user dashboard, or create a new dashboard.
Delete dashboard
You can delete unused dashboards.
Information
The service dashboard cannot be deleted.
To delete the dashboard, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, select the checkbox of the dashboard you want to delete, then click the Delete button. A popup confirming the dashboard deletion will appear.
- You can delete multiple dashboards simultaneously.
- You can also delete individually by clicking the More > Delete button located at the top right of the Dashboard Details page.
- In the delete confirmation input field, type Delete and then click the Confirm button. The dashboard will be deleted.
Manage Widgets
Dashboard Details page lets you edit or manage widgets.
Edit Widget
You can modify the widget’s metrics and resources.
Information
Widgets on the service dashboard cannot be edited.
To modify the widget, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard whose widget you want to edit. You will be taken to the Dashboard Details page.
- On the Dashboard Details page, click the More > Edit Widget button at the top right of the widget you want to edit. The Edit Widget popup will open.
- After modifying the widget’s metrics and resources, click the Confirm button. The widget modification is complete.
| Category | Required status | Detailed description |
|---|
| Indicator classification | Select | In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list |
| Indicator List Area | Required | List of metrics that can be monitored in ServiceWatch- Click the + button in front of the namespace and dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the Selected Metrics area
|
| Search filter area | - | After setting the search items to filter, click the Apply Filter button to filter the metric list- Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Enter the exact metric name to search
- Resource Name: Enter the exact resource name to search
- Resource ID: Enter the exact resource ID to search
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
|
| Selected metric area | - | Monitoring chart for the selected metric in the metric list area- Data graph collected during the period applied to the chart
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking the label name displayed in the legend shows detailed information for that legend in a popup
- In the table area within the chart, you can view and edit legend labels, statistics, and aggregation periods
- Legend: color per legend
- Click a legend color to change it to another color
- Period: period applied to the chart
- Metric: displays the selected metric’s namespace, resource name, and metric name
- Statistics: select the method for aggregating metric data
- Choose among Average (default), Minimum, Maximum, Sum
- Aggregation period: select the aggregation period unit for metric values
- Choose among 1 minute, 5 minutes (default), 15 minutes, 30 minutes, 1 hour, 3 hours, 6 hours, 12 hours, 1 day
- Delete: remove the legend
|
Table. Individual widget additional items
Widget Replication
You can copy the widget and add it to another dashboard.
Information
User permission is required to duplicate the dashboard.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To duplicate a widget, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
On the Dashboard List page, click the dashboard you want to duplicate. You will be taken to the Dashboard Details page.
On the Dashboard Detail page, click the More > Widget Clone button located at the upper right of the widget to be duplicated. The Widget Clone popup window opens.
After selecting the widget duplication method, enter the required information. The required information varies depending on the duplication method.
| Category | Whether required | Detailed description |
|---|
| Replication target | - | Name of the dashboard to duplicate |
| Cloning method | Required | After duplicating the widget, select the dashboard to add it to- Existing Dashboard: Add the widget to an existing dashboard
- New Dashboard: Create a new dashboard and add the widget
|
| Select Dashboard | Required | Select the dashboard to which the duplicated widget will be added from the existing dashboards- When the duplication method is selected as Existing Dashboard, it is displayed
|
| Dashboard name | Required | Enter the name of the new dashboard- Displayed when the duplication method is set to New Dashboard
- Enter using English letters, numbers, and special characters (
-_) within 3 to 40 characters
|
| Widget name | Required | When adding a widget to the dashboard, enter the widget name- English letters, numbers, special characters(
-_.\
|
Table. Widget duplication items
After entering the required information, click the Complete button. A popup window notifying the addition of the widget will open.
Click the Confirm button in the popup window. The widget will be duplicated and added to the dashboard.
Download widget file
You can download widget information as a file.
To download widget information, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard from which you want to download widget information. You will be taken to the Dashboard Detail page.
- Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
- After selecting the file download method, click the Confirm button. The download will start.
- Download methods can be selected simultaneously.
| Category | Detailed description |
|---|
| CSV | Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it. |
| PNG | Convert the widget chart to an image (*.png) file and download |
Table. Widget file download item
Check widget metrics
You can view the widget’s resource and metric information on the Metrics page.
To view widget metrics on the metrics page, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view widget metrics for. You will be taken to the Dashboard Details page.
- On the Dashboard Detail page, click the More > View Metrics button at the top right of the widget you will view on the Metrics page. You will be taken to the Metrics page.
- The resources and metric information of the selected widget are automatically configured and displayed on the Metrics page.
Reference
For detailed information about the
Metric page, please refer to
View Metrics.
Check widget source code
You can view the source code of the dashboard.
information
In the service dashboard, you cannot view the widget’s source information.
To check the dashboard’s source code, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard you want to view details for. You will be taken to the Dashboard Detail page.
- On the Dashboard Details page, click the More > View Source button located at the top right of the widget to view its source code. The Widget Source View popup will open.
| Category | Detailed description |
|---|
| Source information | Display the widget source code in JSON format |
| Copy code | Copy the source code to the clipboard |
Table. Widget source view item
Download widget file
You can download widget information as a file.
To download widget information, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- Dashboard List page, click the dashboard to download widget information. You will be taken to the Dashboard Detail page.
- Dashboard Details page, click the More > File Download button at the top right of the widget whose information you want to download. The File Download popup window opens.
- After selecting the file download method, click the Confirm button. The download will start.
- Download methods can be selected simultaneously.
| Category | Detailed description |
|---|
| CSV | Convert the widget’s metrics and monitoring data to an Excel (*.csv) file and download it. |
| PNG | Convert the widget chart to an image (*.png) file and download |
Table. Widget file download item
Export to Object Storage
You can store widget information in Object Storage.
information
User permissions are required to store data in Object Storage.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To store widget information in Object Storage, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Dashboard > Dashboard List menu. You will be taken to the Dashboard List page.
- On the Dashboard List page, click the dashboard from which you want to download widget information. You will be taken to the Dashboard Detail page.
- On the Dashboard Details page, click the More > Export to Object Storage button located at the top right of the widget whose information you want to download. The Export to Object Storage popup will open.
- After selecting the bucket to store widget information, click the Done button. A popup confirming the save will appear.
- Click the Confirm button in the popup window. Data export will begin.
Information
- The limitations of metrics that can be exported to Object Storage are as follows.
- Number of indicators: up to 10
- Query period: within 2 months (63 days)
- If the query period exceeds 2 months (63 days), only data for up to 63 days will be stored.
Reference
- If there is no Object Storage to store metric data, create an Object Storage first, then proceed.
- Metric data is stored in the “metricname-yyyymmddhhmmss.json” file format and can be accessed in the ~/servicewatch/metric path of the Object Storage bucket.
2 - Alert
In ServiceWatch, you can set threshold criteria for the metrics to be monitored, and create and manage alert policies that generate alert notifications when the specified conditions are met.
Reference
The Auto-Scaling Group policy will be integrated with ServiceWatch starting March 25, 2026.
The policies of an Auto-Scaling Group are created in conjunction with ServiceWatch alarm policies, and alarm policies linked to an Auto-Scaling Group cannot be modified or deleted in ServiceWatch; they can only be managed through the Auto-Scaling Group.
Create Alert Policy
You can create an alert policy for a metric and set the criteria for alert triggering.
To create an alert policy, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Alarm > Alarm Policy menu. You will be taken to the Alarm Policy List page.
Click the Create Alert Policy button on the Alert Policy List page. You will be taken to the Create Alert Policy page.
After entering the name and description of the alert policy in the Basic Information Input area, click the Select Metric button. The Select Metric popup window will open.
Metric Selection In the popup window, after selecting the metric for which to create an alert policy, click the Confirm button. The Metric and Condition Settings area will be displayed.
| Category | Required status | Detailed description |
|---|
| Indicator classification | Required | In ServiceWatch, filter the monitorable metrics as All or Key Metrics and display them in the metric list |
| Indicator List Area | Required | List of metrics that can be monitored in ServiceWatch |
- Click the **+** button in front of the namespace and dimension to view the sub-level list
- When you select a metric to monitor, it is displayed as a chart in the **Selected Metric** area
- If the metric is associated with a namespace, the **Service Dashboard** is displayed
- Clicking the **Service Dashboard** navigates to the detailed page of that dashboard
|
| Search filter area | - | After setting the search items to filter, click the **Apply Filter** button to filter the metric list
- **Namespace-Dimension Name**: Search based on the sub-dimension names of the selected namespace
- **Metric Name**: Enter the exact metric name to search
- **Resource Name**: Enter the exact resource name to search
- **Resource ID**: Enter the exact resource ID to search
- **Keyword**: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- **Tag Key**: Search using the selected tag key
|
| Selected metric area | - | Monitoring chart for the selected metric in the metric list area
- Data graph collected during the period applied to the chart
- When the mouse cursor is placed on the graph, a popup displays the time, data value, and metric data information for that point
- You can drag the mouse to zoom in on a specific area of the graph
- Clicking a label displayed in the legend shows detailed information for that legend in a popup
- In the table area within the chart, you can view and edit legend labels, statistics, and aggregation periods
- **Legend**: color for each legend
- You can click a legend color to change it to another color
- **Period**: period applied to the chart
- **Metric**: displays the selected metric's namespace, resource name, and metric name
- **Statistics**: select the method for aggregating metric data
- Choose among **Average** (default), **Minimum**, **Maximum**, **Sum**
- **Aggregation Period**: select the aggregation period unit for metric values
- Choose among **1 minute**, **5 minutes** (default), **15 minutes**, **30 minutes**, **1 hour**, **3 hours**, **6 hours**, **12 hours**, **1 day**
- **Delete**: remove the legend
|
Table. Indicator selection popup items
Set the threshold values for generating alerts in the Indicator and Condition Settings area.
| Category | Required status | Detailed description |
|---|
| namespace | - | Namespace of the selected metric |
| Indicator name | - | Name of the selected metric |
| unit | - | Data unit of the selected metric |
| Evaluation scope | Required | Time range (seconds) for alarm evaluation- Input allowed up to a maximum of 604,800 seconds in multiples of 60
- If set smaller than the collection interval or not in a multiple of the collection interval, alarm evaluation may be applied abnormally
|
| Statistics | Required | Select the method for calculating metric data over the evaluation range- Sum: The sum of all data point values collected during the period
- Average: The value obtained by dividing the Sum over the specified period by the number of data points during that period
- Minimum: The lowest value observed during the specified period
- Maximum: The highest value observed during the specified period
|
| Additional configuration | Select | Setting evaluation count, violation count, and missing data handling method- When the additional configuration is set to Use, you can set the evaluation count and violation count used for alarm evaluation. If the number of violations meets the condition within the evaluation count during the evaluation period (seconds), the alarm state changes to Alert
- Evaluation Count: Number of evaluations that trigger an alarm
- 1 ~ 8,640 enterable range
- Violation Count: Allowed number of violations before an alarm is triggered
- 1 ~ Evaluation Count enterable range
- If the evaluation period is less than 1 hour (3,600 seconds), evaluation count/evaluation period can be set up to a maximum of 1 day (86,400 seconds)
- If the evaluation period is 1 hour (3,600 seconds) or more, evaluation count/evaluation period can be set up to a maximum of 7 days (604,800 seconds)
- When the additional configuration is set to Use, you can specify how to handle missing data during alarm evaluation.
- Treat missing data as missing (Missing)
- Ignore missing data and maintain the current alarm state (Ignore)
- Treat missing data as satisfying the condition (Breaching)
- Treat missing data as not satisfying the condition (Not breaching)
|
| Condition setting | Required | - Condition Operator: After calculating metric data over the evaluation period, select a condition operator to compare the value with the threshold
- Threshold: After calculating metric data over the evaluation period, set the threshold to compare the value with the condition operator
- Input allowed from 0 ~ 2,147,483,647
- Condition: Explanation of alert state (Alert) change conditions based on the configured Condition Operator and Threshold
|
| Alert level | Required | Select alert stage based on the importance of the alert policy |
| Resource ID | - | Metric monitoring target resource ID |
| Resource Name | - | Metric Monitoring Target Resource Name |
Table. Indicator and Condition Setting Items
In the Notification Settings area, select the user who will receive notifications when an alarm occurs.
- Only users with a login history (users who have registered an email or mobile phone number) can be added as notification recipients.
- You can add up to 100 notification recipients.
Reference
- If there is no user to add, you can create a user on the IAM service’s User Creation page. For detailed information on user creation, refer to Create User.
- The notification reception method (E-mail or SMS) can be changed on the Alert Settings page after selecting the notification target as Service > Alert. For detailed information about alert settings, refer to 알림 설정 확인하기.
- Add tag information in the Additional Information Input area.
- After reviewing the summary information, click the Create button. A popup indicating the creation of the alert policy will open.
- Click the Confirm button. The alert policy has been created.
Reference
Creating an alert policy may take several tens of minutes depending on its scale.
Check detailed alert policy information
You can view and manage detailed information about alert policies.
To view detailed information about the alert policy, follow these steps.
- Click the All Services > Management > ServiceWatch menu. Navigate to the Service Home page.
- On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
- In the Alert Policy menu, you can click the Alert Level button to filter and view only the list of alert policies that correspond to that alert level.
- On the Alert Policy List page, click the alert policy name to view its details. You will be taken to the Alert Policy Details page.
| Category | Detailed description |
|---|
| Alert policy status | Alert policy status- Active: The alert policy is in an active state
- Inactive: The alert policy is in an inactive state
- You can change it by clicking the Activate or Deactivate button
|
| Delete alarm policy | Delete the relevant alert policy |
| Alarm status | Current alert status- Normal: when the metric does not meet the configured condition
- Insulfficient data: when the metric data cannot be verified (missing, nonexistent, not arrived)
- Alert: when the metric meets the configured condition
- When the alert status is Alert, display the alert level (>High, Middle, Low) as well
|
| Metric Monitoring Chart | Metric monitoring chart for the configured period |
| Information Classification Tab | Alert policy information tabs- Details, notifications, alert history, tags, operation history
- Click each tab to view the corresponding information
|
Table. Alarm detailed items
Reference
When sorting alarm policy names in the alarm policy list, follow the sorting rules below.
- Whitespace and control characters
- Some special characters (
!"#$%&’()*+,-./ ) - Numbers (
0–9) - Some special characters (
; < = > ? @ ) - English (
A–Z, a–z, case-insensitive) - Remaining special characters (
[\]^_`) - Other characters
On the Alert Policy List page, you can view the selected alert policy’s basic information and metric information.
| Category | Detailed description |
|---|
| Service | service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform- In ServiceWatch, it refers to the SRN of the resource type
|
| Resource Name | Resource name- In ServiceWatch, it refers to the name of the alert policy
|
| Resource ID | Unique resource ID in the service |
| Constructor | User who created the service |
| Creation date | Service creation timestamp |
| Editor | User who edited the service information |
| Modification date and time | Date and time the service information was modified |
| Alert Policy Name | Name of the alert policy |
| Namespace | Metric namespace |
| Indicator Name | Indicator name |
| Evaluation scope | Time range for alert evaluation |
| unit | Unit of indicator data |
| Evaluation count | Alert policy evaluation count |
| Number of violations | Number of alert policy violations |
| Statistics | Method of calculating metric data during the evaluation period |
| evaluation interval | Evaluation interval: evaluation range (unit) × number of evaluations |
| Condition | Alert state change condition based on the configured condition operator and threshold |
| Alert level | Alert level when an alert occurs |
| Target metric information area | Description of the alert policy target metric, resource ID, and resource name |
Table. Alert Policy Details – Details Tab Items
Notification
On the Alert Policy List page, you can view the notification recipients of the selected alert policy.
| Category | Detailed description |
|---|
| Notification recipient list | User ID, creation date and time, last login, status information- More button to click to change the notification status (enabled/disabled) for the user or delete the user
|
| Delete | Delete all selected users from the notification recipient list- Enabled when you check the users to delete from the notification recipient list
|
| More | Change the notification status (enable/disable) for the selected user in the notification recipient list- When you check the user whose status you want to change in the notification recipient list, it becomes enabled
|
| Add notification recipient | Add new notification recipient possible- Add Notification Recipient Select users to add in the popup window
|
Table. Alarm Policy Details - Notification Tab Items
Reference
- Only users with a login history (users who have registered an email or mobile phone number) can be added as notification recipients.
- You can add up to 100 notification recipients.
- If there is no user to add, you can create a user on the IAM service’s User Creation page. For detailed information on creating users, see Create User.
- The notification delivery method (E-mail or SMS) can be changed on the Notification Settings page after selecting the notification target as Service > Alert. For more details on notification settings, see Check Notification Settings.
Reference
You cannot add notification recipients to alarm policies associated with an Auto-Scaling Group.
Alert History
Alarm Policy List page lets you view the alarm status change history of the selected alarm policy.
| Category | Detailed description |
|---|
| Alert History List | Alarm status change timestamp, change status classification information, alarm description- Click View Details to view the detailed information of the alarm history and the source code in JSON format
|
| View Details | You can view detailed alarm history information and the source code in JSON format- Enabled only when one alarm is selected from the alarm history list to view its details
|
Table. Alert Policy Details - Alert History Tab Items
tag
Alert Policy List page lets you view the tag information of the selected alert policy, and you can add, modify, or delete it.
| Category | Detailed description |
|---|
| Tag list | Tag’s Key and Value information |
| Edit tag | You can modify, delete, or add new tags to existing tag information- Up to 50 tags can be added per resource
- When adding a tag, entering a Key and Value allows you to select from the list of previously created tag Keys and Values
|
Table. Alert Policy Details - Tag Tab Items
Job History
You can view the operation history of the selected alert policy on the Alert Policy List page.
| Category | Detailed description |
|---|
| Task History List | Resource Change History- You can view task details, task date and time, resource type, resource name, task result, and operator information
- Click the Settings button to modify information fields
- Filtering is possible using Period Selection, User Time Zone, entering operator information, and Advanced Search
- Click a task entry in the Task History List to navigate to the Task Activity Details page for that task
|
Table. Alert Policy Details - Work History Tab Items
Modify Alert Policy
You can modify the target metrics and policy settings of the alert policy.
To modify the alert policy, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Alert > Alert Policy menu. It navigates to the Alert Policy List page.
- On the Alert Policy List page, click the alert policy name to view detailed information. You will be taken to the Alert Policy Details page.
- On the Detail Information tab of the Alert Policy Details page, click the Edit button of Metric Information. The Edit Metric Information popup opens.
- After modifying the metric information and policy settings, click the Confirm button. A popup notifying the metric modification will open.
- Click the Confirm button. The alert policy update is complete.
Reference
Alarm policies associated with an Auto-Scaling Group can be modified through the Auto-Scaling Group.
Disable Alert Policy
You can disable the alert policy to stop sending notifications when the alert status changes.
Even if the alert policy is disabled, alert evaluation continues, and alert history accumulates as the alert status changes. However, notifications are not sent.
If you want to block receiving notifications for a specific period, you can disable the corresponding alert policy.
To disable the alert policy, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
- On the Alert Policy Details page, click the Disable button. The Alert Policy Deactivation Notification popup opens.
- Click the Confirm button. Check the status of the alert policy.
Reference
Alert policies associated with an Auto-Scaling Group cannot be enabled or disabled.
Activate Alert Policy
You can enable the alert policy to resume sending notifications when the alert status changes.
To enable the alert policy, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
- On the Alert Policy Details page, click the Enable button. The Alert Policy Activation Notification popup window opens.
- Click the Confirm button. Check the status of the alert policy.
Reference
Alarm policies associated with an Auto-Scaling Group cannot be enabled or disabled.
Delete Alert Policy
You can delete unused alert policies.
To delete an alert policy, follow these steps.
- All Services > Management > ServiceWatch menu, click it. You will be taken to the Service Home page.
- On the Service Home page, click the Alert > Alert Policy menu. You will be taken to the Alert Policy List page.
- On the Alert Policy List page, select the checkbox of the alert policy you want to delete, then click the Delete button. A popup notifying the alert policy deletion will appear.
- You can delete multiple alert policies at once.
- You can also delete individually by clicking the Delete button at the far right of each alert policy, or by clicking the Delete Alert Policy button on the corresponding Alert Policy Details page.
- Click the Confirm button. The alert policy will be deleted.
Reference
Alarm policies associated with an Auto-Scaling Group can be deleted through the Auto-Scaling Group.
Reference
Deleting an alarm policy can take several tens of minutes, depending on its scale.
3 - indicator
Users can monitor metrics of service resources in the Samsung Cloud Platform Console and use them for management.
Check Indicators
You can view the metrics available in ServiceWatch.
To check the indicator, follow these steps.
- All Services > Management > ServiceWatch menu, click it. 1. Go to the Service Home page.
- On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
- Check the metrics in the metric list on the Metrics page.
| Category | Detailed description |
|---|
| Indicator Comparison Mode | Select the method for comparing indicators- Indicator Comparison: Select multiple indicators and resources to compare within a specific date or period
- Date Comparison: Select a single indicator and resource to compare for a specific date or period
- Only one indicator can be selected
|
| Indicator classification | Display the metrics that can be monitored in ServiceWatch, filtered and categorized as All or Key Metrics, in the metric list |
| Indicator List Area | List of metrics that can be monitored in ServiceWatch- Click the + button in front of the namespace or dimension to view the sub-level list
- Select a metric to monitor
- If the metric is associated with a namespace, Service Dashboard is displayed
- Click Service Dashboard to navigate to the detailed page of that dashboard
|
| Search filter area | After setting the search items to filter, click the Apply Filter button to filter the metric list- Namespace-Dimension Name: Search based on the sub-dimension names of the selected namespace
- Metric Name: Enter the exact metric name to search
- Resource Name: Enter the exact resource name to search
- Resource ID: Enter the exact resource ID to search
- Keyword: Search based on the selected top-level category and the entered keyword
- Proceed with item-specific searches excluding metric name, resource name, resource ID, and tag key
- Tag Key: Search using the selected tag key
|
| Selected indicator | Display monitoring information for the selected metric from the metric list |
Table. Indicator list items
Manage Indicator Charts
You can add the metric monitoring result chart as a widget or manage the data.
Add as widget
You can add the selected metric as a widget to the dashboard.
information
You can add it as a widget only when you select the Metric Comparison mode.
To add a metric as a widget, follow these steps.
All Services > Management > ServiceWatch Click the menu. 1. Go to the Service Home page.
On the Service Home page, click the Metrics menu. 2. Navigate to the Indicator page.
Select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
After configuring the table area in the monitoring chart of the Selected metric region, click the More > Add widget button. 4. Add Widget The popup window opens.
After selecting the method to add the widget, enter the required information. 5. The required information varies depending on the addition method.
| Category | Required status | Detailed description |
|---|
| Replication Method | Required | After duplicating the widget, select the dashboard to add it to- Existing Dashboard: Add the widget to the existing dashboard
- New Dashboard: Create a new dashboard and add the widget
|
| Select Dashboard | Required | Select the dashboard to which the duplicated widget will be added among the existing dashboards- Displayed when the duplication method is selected as Existing Dashboard
|
| Dashboard name | Required | Enter the name of the new dashboard- Displayed when selecting the duplication method as New Dashboard
- Enter using English letters, numbers, and special characters (
-_) within 3 ~ 40 characters
|
| Widget name | Required | When adding a widget to the dashboard, enter- English letters, numbers, special characters(
-_.\
|
Table. Widget additional items
When you have finished entering the required information, click the Complete button. 6. A popup window notifying the addition of a widget opens.
Click the Confirm button on the popup window. 7. A widget will be added to the dashboard.
Share monitoring chart URL
You can download monitoring chart information as a file.
To download the monitoring chart information, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Navigate to the Service Home page.
- On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
- Select the metric to monitor from the metric list on the Metrics page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
- After setting the table area in the monitoring chart of the Selected metric region, click the More > URL Share button. 4. URL sharing A popup window opens.
- In the URL Share popup, click the Copy URL button. 5. The generated URL is copied.
- Information within the monitoring chart is provided as metadata links.
Download Monitoring Chart File
You can download monitoring chart information as a file.
To download the monitoring chart information, follow these steps.
- All Services > Management > ServiceWatch menu, click it. 1. Go to the Service Home page.
- On the Service Home page, click the Metrics menu. 2. Navigate to the Indicator page.
- Select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
- In the monitoring chart of the selected metric area, set the table region, then click the More > File Download button. 4. File Download popup window opens.
- After selecting the file download method, click the Confirm button. 5. The download will start.
- The download method can be selected simultaneously.
| Category | Detailed description |
|---|
| CSV | Convert chart metrics and monitoring data to an Excel (*.csv) file and download |
| PNG | Convert the chart to an image (*.png) file and download- Available only when the metric comparison mode is set to Metric Comparison
- Up to 100 metric data items can be downloaded
|
Table. Indicator monitoring file download item
Export to Object Storage
You can store monitoring chart data in Object Storage.
information
User permission is required to store in Object Storage.
- User: {email}
- Action: iam:CreatGroup
- On resource: {SRN}
- Context: no identity-based policy allows the action
To store monitoring chart data in Object Storage, follow these steps.
- All Services > Management > ServiceWatch click the menu. 1. Go to the Service Home page.
- On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
- Select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
- In the monitoring chart of the Selected metric area, after setting the table region, click the More > Export to Object Storage button. 4. Object Storage Export The popup window opens.
- After selecting the bucket to store the data, click the Done button. 5. A popup window notifying data saving opens.
- Click the Confirm button in the popup window. 6. Data export is starting.
information
- The limitations of metrics that can be exported to Object Stroage are as follows.
- Number of indicators: up to 10
- Query period: within 2 months (63 days)
- If the query period exceeds 2 months (63 days), only data for up to 63 days will be stored.
Reference
- If there is no Object Storage to store the metric data, create an Object Storage and then proceed.
- Metric data is stored in the “MetricName-yyyymmddhhmmss.json” file format and can be accessed in the ~/servicewatch/metric path of the Object Storage bucket.
View monitoring chart source
You can view the source code of the monitoring chart.
information
You can view the source code only when you select the metric comparison mode as Metric Comparison.
To view the source code of the monitoring chart, follow these steps.
- Click the All Services > Management > ServiceWatch menu. 1. Go to the Service Home page.
- On the Service Home page, click the Metrics menu. 2. Go to the Indicator page.
- Please select the metric to monitor from the metric list on the Metric page. 3. The monitoring chart for the selected metric is displayed in the Selected Metric area at the bottom.
- After setting the table area in the monitoring chart of the selected metric region, click the More > View Source button. 4. View Widget Source A popup window opens.
| Category | Detailed description |
|---|
| Source information | Display the source code of the monitoring chart in JSON format |
| Copy code | Copy the source code to the clipboard |
Table. Monitoring chart source view items
4 - Log
In ServiceWatch, you can set threshold criteria for the metrics you monitor, and when the specified conditions are met, you can create and manage log groups to generate alarm notifications.
Create Log Group
You can create a log group for the metric.
To create a log group, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
Log Group List page, click the Create Log Group button. You will be taken to the Create Log Group page.
Enter the basic information and tag information required to create a log group.
| Category | Whether required | Detailed description |
|---|
| Log group name | Required | Enter the name of the log group to monitor in ServiceWatch- using English letters, numbers, and special characters (
-_./#) within 3 ~ 512 characters
|
| Log retention policy | Required | Select the retention period for monitored log data |
| Tag | Select | Add tag information- Up to 50 tags can be added per resource
- When adding a tag, entering the Key and Value allows selection from the list of previously created tag Keys and Values
|
Table. Log group creation items
After reviewing the summary information, click the Create button. A popup notifying the creation of the log group will appear.
Click the Confirm button. Log group creation is complete.
Check log group details
You can view and manage detailed information about log groups.
To view detailed information about the log group, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- On the Log Group List page, click the log group name to view detailed information. You will be taken to the Log Group Details page.
| Category | Detailed description |
|---|
| Log group status | Log group status- Active: The log group is in an active state
- Inactive: The log group is in an inactive state
|
| Export Log Group | Store log group log data in Object Storage |
| Delete log group | Delete the corresponding log group |
| Information Classification Tab | Information tabs for log groups- Details, Log Streams, Tags, Activity History
- Click each tab to view the corresponding information
|
Table. Log Group Details
Reference
On the Log Group List page, click the More > Export Log Group button for the log group you want to store in Object Storage to export the data.
Reference
When sorting log group names in the log group list, follow the sorting rules below.
- Whitespace and control characters
- Some special characters (
!"#$%&’()*+,-./ ) - Numbers (
0–9) - Some special characters (
; < = > ? @ ) - English (
A–Z, a–z, case-insensitive) - Remaining special characters (
[\]^_`) - Other characters
Log Group List page allows you to view the basic information and details of the selected log group.
| Category | Detailed description |
|---|
| Service | Service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform- In ServiceWatch, it refers to the SRN of the resource type
|
| Resource Name | Resource name- In ServiceWatch, it refers to the name of the log group
|
| Resource ID | Unique resource ID in the service |
| Constructor | User who created the service |
| Creation date and time | Service creation date and time |
| Editor | User who edited the service information |
| Modification date and time | Date and time the service information was modified |
| Log group name | Name of the log group |
| Log retention policy | Retention period of log data- Edit Click the button to change the retention period
|
| Log data | Total stored log data size (bytes) |
Table. Log Group Details – Details Tab Items
Reference
Log data is the total stored log data (bytes). It may take time for the log aggregation capacity to be reflected.
Log Stream
Log Group List page allows you to view the log streams of the selected log group.
| Category | Detailed description |
|---|
| View all streams | Detailed information for all log streams in the log stream list can be viewed |
| Create log stream | Create a new log stream |
| Log stream list | Log stream name and log modification timestamp- Click the log stream name to view detailed information of that log stream
- Delete button can be clicked to delete the log stream
- After checking the log streams to delete, click the More > Delete button at the top of the list to delete them simultaneously
|
Table. Log Group Details - Log Stream Tab Items
log pattern
Log Group List page allows you to view the log pattern of the selected log group.
| Category | Detailed description |
|---|
| Log pattern list | Log pattern name, pattern, log pattern namespace, metric name, alert policy name information- Clicking the log pattern name or alert policy name navigates to the detail page of that item
- Clicking the metric name navigates to the metric page that includes that metric name in the search query
- Clicking the alert policy name navigates to the detail page of that alert policy
- More button can be clicked to perform additional actions
- Edit, Delete: modify or delete the log pattern
- Create Alert Policy: navigate to the alert policy creation page
|
| Delete | Delete all selected log patterns from the log pattern list- Activates when a log pattern is checked in the log pattern list
|
| Generate log pattern | Create a new log pattern |
Table. Log Group Details - Log Pattern Tab Items
tag
On the Log Group List page, you can view the tag information of the selected log group and add, modify, or delete it.
| Category | Detailed description |
|---|
| Tag list | Tag’s Key and Value information |
| Edit tag | You can modify, delete, or add new tags to existing tag information- Up to 50 tags can be added per resource
- When adding a tag, entering the Key and Value allows you to select from the list of previously created tag Keys and Values
|
Table. Log Group Details - Tag Tab Items
Job History
Log Group List page lets you view the operation history of the selected log group.
| Category | Detailed description |
|---|
| Task History List | Resource Change History- You can view task details, task date/time, resource type, resource name, task result, and operator information
- Settings button can be clicked to modify information fields
- Filtering is possible using Period Selection, User Time Zone, entering operator information, and Detailed Search
- Click a task entry in the Task History List to navigate to the Task Activity Details page for that task
|
Table. Log Group Details - Work History Tab Items
Managing Log Streams
You can create and manage log streams.
Create Log Stream
You can create a new log stream in a log group.
To create a Hog stream, follow the steps below.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- On the Log Group List page, click the log group name for which you want to create a log stream. You will be taken to the Log Group Details page.
- Log Group Details page, click the Log Stream tab. The Log Stream list is displayed.
- Click the Create Log Stream button. The Create Log Stream popup opens.
- Enter the Log stream name, then click the Create button. Log stream creation is completed.
- Enter the name using English letters and numbers, within 3~512 characters.
Check detailed log stream information
You can view and manage detailed information about log streams.
To view detailed information about the log stream, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- Click the log group name on the Log Group List page to view detailed information. You will be taken to the Log Group Details page.
- On the Log Group Details page, click the Log Stream tab. The Log Stream list is displayed.
- Click the log stream name in the Log Stream list to view its details. You will be taken to the Log Stream Details page.
| Category | Detailed description |
|---|
| Excel download | Log stream history can be downloaded as an Excel file |
| Timestamp list | Message list by timestamp- Period selection, User time zone, can filter using message input
|
Table. Log group details - Log stream detail items
Reference
When you click the View All Log Streams button at the top of the log stream list, you will be taken to the All Log Stream Details page.
Delete Log Stream
You can delete unused log streams.
To delete a log stream, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- On the Log Group List page, click the log group name whose log stream you want to delete. You will be taken to the Log Group Details page.
- Log Group Details page, click the Log Stream tab. The log stream list will be displayed.
- Select the checkbox of the log stream to delete in the log stream list, then click the More > Delete button. A popup notifying the log stream deletion will open.
- You can delete multiple log streams simultaneously.
- You can also delete each individually by clicking the Delete button at the right end of each log stream.
- Click the Confirm button. The log stream will be deleted.
Managing Log Patterns
Create Log Pattern
To create a log pattern, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
On the Log Group List page, click the log group name for which you want to create a log pattern. You will be taken to the Log Group Details page.
Log Group Details page, click the Log Pattern tab. The log pattern list will be displayed.
Click the Create Log Pattern button. You will be taken to the Create Log Pattern page.
Set the basic information and metric information required to create a log group.
- In the Basic Information area, enter and select the basic information for the log pattern.
| Category | Required | Detailed description |
|---|
| Log pattern name | Required | Enter the name of the log pattern- using English letters, numbers, and special characters (
-_./#) within 3 ~ 512 characters
|
| Pattern format | Required | Select a pattern format or enter manually- Pattern format: Choose one of the string pattern, space-delimited pattern, or JSON format pattern provided as pattern formats
- Direct input: After selecting one of the string pattern, space-delimited pattern, or JSON format pattern, enter a value between 1 ~ 1,024
|
| Pattern test | Select | Enter or select log data to verify using a pattern- Direct Input: Enter the log data to be used directly into the Log Event Message
- Separate log events using line breaks
- Up to 50 log events can be entered
- Each log event can be entered within 1 ~ 1,024 bytes
- Log Data Selection: Choose the log data to use
- When selecting log data, the corresponding log data is displayed in the Log Event Message
- Pattern Test: Conduct a test on the log event message
- If the test succeeds, the test result is displayed at the bottom
|
Table. Log Pattern Creation - Basic Information Items
- Enter and select metric information in the Metric Information area.
| Category | Required status | Detailed description |
|---|
| namespace | Required | Select a namespace for the log pattern- If there is no namespace for the log pattern, Create New to create one
- Namespace Name: When creating a new namespace, use English letters, numbers, spaces, and special characters(
-_\/#) to enter between 3 ~ 128 characters
|
| Indicator Name | Required | Enter the name of the indicator- using English letters, numbers, and special characters(
_) within 3 ~ 128 characters
|
| indicator value | Required | Enter the indicator value- a number greater than or equal to 0 or
$indetifier
|
| default | Select | If you use the default value, enter- When using the default, dimension cannot be used
|
| unit | Required | Select indicator unit |
| dimension | Selection | Set the dimension of metrics generated by log patterns- Log pattern format is available only when it is a space-delimited pattern or a JSON format pattern
- Default value cannot be used when entered
- If Use is checked, you can add custom dimension fields
- After clicking the Add button, add by entering Field name and Field value
- You can add up to a maximum of 3
|
Table. Log pattern generation - metric information items
After reviewing the summary information, click the Create button. A popup indicating log pattern creation will appear.
Confirm click the button. Log pattern generation is complete.
Check detailed log pattern information
To view detailed information about the log pattern, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- Click the log group name to view detailed information on the Log Group List page. You will be taken to the Log Group Details page.
- Log Group Details page, click the Log Pattern tab. The log pattern list will be displayed.
- Log pattern Click the log pattern name in the list to view its details. Log pattern details page will open.
| Category | Detailed description |
|---|
| Create alert policy | Alert policy creation available- When the button is clicked, navigate to the alert policy creation page
|
| Delete log pattern | Delete the log pattern currently being examined |
| Log pattern name | Log pattern name |
| constructor | User who created the log pattern |
| Creation date and time | Log pattern creation timestamp |
| Editor | User who modified the log pattern information |
| Modification date | Date and time the log pattern information was modified |
| Pattern | Pattern format |
| Indicator Information | Metric information of the pattern group- Namespace name, metric name, metric value, default value, unit, alarm policy name, dimension name
- Edit button allows modification of metric value, default value, unit information
|
Table. Log pattern detailed items
Delete log pattern
To delete a log pattern, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- On the Log Group List page, click the log group name whose log pattern you want to delete. You will be taken to the Log Group Details page.
- On the Log Group Details page, click the Log Pattern tab. The log pattern list will be displayed.
- After selecting the checkbox of the log pattern to delete in the log pattern list, click the Delete button. A popup notifying the log pattern deletion will open.
- You can delete multiple log patterns simultaneously.
- You can also delete individually by clicking the More > Delete button at the far right of each log pattern, or by clicking the Delete Log Pattern button on the log pattern’s detail page.
- Click the Confirm button. The log pattern will be deleted.
Export Log Group
Log group data can be stored in Object Storage.
To store log group data in Object Storage, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Log > Log Group Export menu. You will be taken to the Log Group Export List page.
Log Group Export List page, click the Log Group Export button. You will be taken to the Log Group Export page.
| Category | Required | Detailed description |
|---|
| Select log group | Required | Select the log group to store in Object Storage- If the log group contains log streams, you can click the Select button to choose the log stream to store
- If no log group is selected, the entire data of the log group will be stored
|
| Select period | Select | Select the user time zone and data storage interval- In the Time Settings area, you can select the desired interval or click the Enter Manually button to set the start and end date and time
|
| storage bucket | Required | Select the bucket to store data- Up to 50 tags can be added per resource
- When adding a tag, entering the Key and Value allows you to select from the list of existing tag Keys and Values
|
Table. Log group export items
After selecting the bucket to store the data, click the Complete button. A popup notifying that the data has been saved will open.
In the popup window, click the Confirm button. Data export will begin.
- You can view the progress on the Log Group Export List page.
Reference
- If there is no Object Storage to store the log group data, create an Object Storage and then proceed.
- Exporting log group data may take tens of minutes or more, depending on its size.
- If there is an ongoing log group export task within the Account, you must first complete the ongoing task before proceeding with the export.
- On the Log Group Export List page, you can cancel an export operation for a log group that is in progress by clicking the More > Cancel Log Group Export button.
Delete Log Group
You can delete unused log groups.
Caution
- Log Group Export does not delete files stored in Object Storage. However, the Log Group Export history is deleted together.
- If you delete a log group while log group export is in progress, the export operation will not complete successfully.
To delete a log group, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Log > Log Group menu. You will be taken to the Log Group List page.
- On the Log Group List page, select the checkbox of the log group you want to delete, then click the Delete button. A popup notifying the log group deletion will appear.
- You can delete multiple log groups simultaneously.
- You can delete individually by clicking the Delete button at the far right of each log group, or by clicking the Delete Log Group button on the Log Group Details page.
- Click the Confirm button. The log group will be deleted.
5 - Event
You can view and handle events generated by the Samsung Cloud Platform service in ServiceWatch.
Create Event Rule
You can create an event rule to receive notifications when an event occurs.
To create an event rule, follow these steps.
Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
On the Service Home page, click the Event Rules menu. You will be taken to the Event Rules List page.
Event Rule List page, click the Create Event Rule button. You will be taken to the Create Event Rule page.
Enter the name and description of the event rule in the Basic Information Input area.
Set the required information in the Event Pattern Configuration area. The configured event pattern is entered in Event Pattern Configuration Status as JSON code.
| Category | Required status | Detailed description |
|---|
| Event source | Required | Select the service name of the event you want to receive in ServiceWatch |
| Event type | Required | Select the event type of the event source to use in the event rule- Classify the same as the resource type
|
| Apply Event | Required | Select events to apply the event pattern from events generated by the event type- All events: Apply all events generated by the event type
- Individual events: Choose events from those generated by the event type to set as the event pattern
|
| Applied resource | Required | Select the resource to apply the event pattern- All resources: Set the event pattern for events that occur in all resources
- Individual resource: Set the event pattern for the specific event that occurs in a particular resource
- When an individual resource is selected, display the event resource selection area
- Add resource button can be clicked to select resources
- Added resources can be removed by selecting the resource in the resource list and clicking the Delete button
|
| Event Pattern Configuration Status | - | Convert and display in JSON code format according to the event pattern settings- Changing the event pattern settings will reset
- Copy code item can be clicked to copy the source code
|
Table. Event pattern configuration items
In the Notification Settings area, select the users who will receive notifications when an event occurs.
- Only users with a login history (users who have registered an email or mobile phone number) can be added as notification recipients.
- You can add up to 100 notification recipients.
Reference
- If there is no user to add, you can create a user on the User Creation page of the IAM service. For more details on creating users, see Create User.
- The notification delivery method (E-mail or SMS) can be changed on the Notification Settings page after selecting the notification target as Service > Event Rule. For detailed information about notification settings, refer to 알림 설정 확인하기.
- Add tag information in the Additional Information Input area.
- After checking the summary information, click the Create button. A popup notifying the creation of an event rule will open.
- Click the Confirm button. Event rule creation is complete.
Check detailed event rule information
You can view and manage detailed information about event rules.
Follow the steps below to view detailed information about the event rules.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Event Rules menu. You will be taken to the Event Rules List page.
- Event Rules List page, click the event name to view detailed information. You will be taken to the Event Rules Detail page.
| Category | Detailed description |
|---|
| Event rule status | Event rule status- Active: The event rule is in an active state
- Inactive: The event rule is in an inactive state
- You can change it by clicking the Activate or Deactivate button
|
| Delete event rule | Delete the corresponding event rule |
| Information Category Tab | Information tabs for alert policies- Details, notifications, tags, activity history
- Click each tab to view the corresponding information.
|
Table. Event rule details
Event Rule List page lets you view the basic information and event rule details of the selected rule.
| Category | Detailed description |
|---|
| Service | Service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform- In ServiceWatch, it refers to the SRN of the resource type
|
| Resource name | Resource name- In ServiceWatch, it refers to the name of the event rule
|
| Resource ID | Unique resource ID in the service |
| constructor | User who created the service |
| Creation date and time | Service creation date and time |
| Editor | User who edited the service information |
| Modification date and time | Date and time the service information was modified |
| Event rule name | Event rule name |
| Event Pattern Configuration Status | Display event pattern settings in JSON code format- Edit button can be clicked to modify the event pattern
- Copy Code item can be clicked to copy the source code
|
| description | Description of event rules- Click the Edit button to edit the description
|
Table. Alert Policy Details – Details Tab Items
Notification
Event Rule List page allows you to view the notification recipients of the selected event rule.
| Category | Detailed description |
|---|
| Notification recipient list | User ID, creation date and time, last login, status information- Click the More button to change the notification status (enabled/disabled) for the user or delete the user
|
| Delete | Delete all selected users from the notification recipient list- Enabled when you check the users to delete from the notification recipient list
|
| More | Change the notification status (enable/disable) for the selected user in the notification recipient list- When you check the user whose status you want to change in the notification recipient list, it becomes enabled
|
| Add notification recipient | Ability to add new notification recipients- Add Notification Recipient Select users to add in the popup window
|
Table. Event rule details - Notification tab items
Reference
- Only users with a login history (users who have registered an email or mobile phone number) can be added as notification recipients.
- You can add up to 100 notification recipients.
- If there is no user to add, you can create a user on the IAM service’s User Creation page. For detailed information on creating users, refer to Create User.
- The notification reception method (E-mail or SMS) can be changed on the Notification Settings page after selecting the notification target as Service > Event Rule. For detailed information about notification settings, refer to 알림 설정 확인하기.
tag
Event Rules page allows you to view the tag information of the selected event rule, and add, modify, or delete it.
| Category | Detailed description |
|---|
| Tag list | Tag’s Key and Value information |
| Edit tag | You can modify or delete existing tag information, or add new tags- Up to 50 tags can be added per resource
- When adding a tag, entering the Key and Value allows you to select from the list of previously created tag Keys and Values
|
Table. Event Rule Details – Tag Tab Items
Job History
You can view the operation history of the event rule selected on the Alert Policy List page.
| Category | Detailed description |
|---|
| Task History List | Resource Change History- You can view the task details, task date and time, resource type, resource name, task result, and operator information
- Click the Settings button to modify information items
- Filtering is possible using Period Selection, User Time Zone, entering operator information, and Detailed Search
- Clicking a task entry in the Task History List navigates to the Task Activity Details page for that task
|
Table. Event Rule Details - Work History Tab Items
Modify event pattern
You can modify the event pattern.
To modify the event pattern, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Event Rules menu. You will be taken to the Event Rules List page.
- Event Rule List page, click the event name to edit the event pattern. You will be taken to the Event Rule Details page.
- Click the Edit button in the Event Pattern Configuration Status on the Event Rule Details page. The Edit Event Pattern popup opens.
- After modifying the event pattern settings, click the Confirm button. A popup notifying the event pattern modification will appear.
- Click the Confirm button. The event pattern modification is complete.
Delete Event Rule
You can delete unused event rules.
To delete an event rule, follow these steps.
- Click the All Services > Management > ServiceWatch menu. You will be taken to the Service Home page.
- On the Service Home page, click the Event Rules menu. You will be taken to the Event Rules List page.
- On the Event Rule List page, select the checkbox of the event rule you want to delete, then click the Delete button. A popup notifying the deletion of the event rule will appear.
- You can delete multiple event rules simultaneously.
- You can also delete individually by clicking the More > Delete button at the far right of each alert policy, or by clicking the Delete Event Rule button on the Event Rule Details page.
- Click the Confirm button. The event rule will be deleted.
6 - Using ServiceWatch Agent
Users can install the ServiceWatch Agent on Virtual Server/GPU Server/Bare Metal Server, etc., to collect custom metrics and logs.
Reference
Collecting custom metrics/logs via the ServiceWatch Agent is currently available only on Samsung Cloud Platform For Enterprise. It will be offered in other offerings in the future.
Caution
Metric collection through the ServiceWatch Agent is classified as custom metrics and, unlike the default metrics collected from each service, incurs charges, so you must be careful not to configure unnecessary metric collection. Ensure that only the metrics that need to be collected are collected.
ServiceWatch Agent
The agents that need to be installed on the server to collect custom metrics and logs for ServiceWatch can be divided into two main types.
It is a Prometheus Exporter and Open Telemetry Collector.
| Category | Detailed description | |
|---|
| Prometheus Exporter | Provide metrics of a specific application or service in a format that Prometheus can scrape- To collect OS metrics from servers, you can use Node Exporter for Linux servers and Windows Exporter for Windows servers, depending on the OS type.
- Target
- Multi-node GPU Cluster > GPU Node
- You can use the DCGM (NVIDIA Data Center GPU Manager) Exporter for GPU metrics.
- Target
- Multi-node GPU Cluster > GPU Node
| |
| Open Telemetry Collector | Acts as a centralized collector that gathers telemetry data such as metrics and logs from distributed systems, processes (filtering, sampling, etc.) it, and exports it to various backends (e.g., Prometheus, Jaeger, Elasticsearch, etc.)- Exports data to the ServiceWatch Gateway so that ServiceWatch can collect metric and log data.
- This guide provides instructions on how to use the OpenTelemetry Collector provided by ServiceWatch.
| |
Table. Explanation of Prometheus Exporter and Open Telemetry Collector
Reference
To link a server’s log files to ServiceWatch via the ServiceWatch Agent, you must first create a log group and a log stream within that log group.
- For detailed information on creating log groups and log streams, refer to the 로그.
Pre-configuration for ServiceWatch Agent
You need to add a Security Group and firewall rules to enable communication between the ServiceWatch Agent and ServiceWatch.
Reference
Bare Metal Server does not support Security Groups.
Add Security Group rule
- To transmit the data collected by ServiceWatch from the ServiceWatch Agent installed on Virtual Server/GPU Server to ServiceWatch, you need to add a rule to the Security Group as follows.
Table. Security Group rules for ServiceWatch Agent communication
Add firewall rule
- If you configure the VPC’s Internet Gateway to use a firewall, you must add firewall rules as shown below.
Table. Internet Gateway firewall rules for ServiceWatch Agent communication
ServiceWatch OpenAPI Endpoint IP address
The Endpoint IP address required for the ServiceWatch Agent to send the data collected to ServiceWatch is as follows.
Table. ServiceWatch OpenAPI Endpoint Information
Open Telemetry Collector configuration for ServiceWatch
Install the OpenTelemetry Collector on the server following the steps below to collect ServiceWatch metrics and logs.
- Download the Agent file from the URL that provides the Agent file for ServiceWatch.
information
The file download link for installing the Agent for ServiceWatch can be found in ServiceWatch’s
Service Home > Start Widget.
Also, you can verify it using ServiceWatch’s
ShowAgentDownloadLink API. For more information, see the
ServiceWatch API Reference.
wget [ServiceWatch Agent file download URL]
wget [ServiceWatch Agent file download URL]
Code block. Command to download the Agent installation file for ServiceWatch- The Open Telemetry Collector Agent file for ServiceWatch can be found as follows.
- Extract the Agent file for ServiceWatch.
unzip ServiceWatch_Agent.zip
unzip ServiceWatch_Agent.zip
Code block. Extract the Agent file for ServiceWatch - When using the ServiceWatch Agent on a Linux OS, you must grant execution permission as shown below.
chmod +x agent/otelcontribcol_linux_amd64
chmod +x agent/servicewatch-agent-manager-linux-amd64
chmod +x agent/otelcontribcol_linux_amd64
chmod +x agent/servicewatch-agent-manager-linux-amd64
Code block. Grant execution permission to the Agent file for ServiceWatch| Category | Detailed description |
|---|
| examples | Example configuration file folder. Each folder contains agent.json, log.json, metric.json example filesos-metrics-min-examples: Minimal metric configuration example using Node Exporter
os-metrics-all-examples: Example of memory/filesystem Collector metric configuration using Node Exporter
gpu-metrics-min-examples: Minimal metric configuration example using DCGM Exporter
gpu-metrics-all-examples: Example of major metric configuration using DCGM Exporter
|
| otelcontribcol_linux_amd64 | Open Telemetry Collector for Linux for ServiceWatch |
| otelcontribcol_windows_amd64.exe | Open Telemetry Collector for Windows for ServiceWatch |
| servicewatch-agent-manager-linux-amd64 | ServiceWatch Agent Manager for Linux |
| servicewatch-agent-manager-windows-amd64.exe | ServiceWatch Agent Manager for Windows |
Table. Agent file configuration for ServiceWatch
Reference
ServiceWatch Agent Manager is a tool that integrates with ServiceWatch to assist in configuring the OpenTelemetry Collector for efficiently transmitting custom metrics and logs. Through this, various custom metrics and log data can be delivered to ServiceWatch.
Define the Agent configuration file in ServiceWatch Agent Manager for the ServiceWatch Open Telemetry Collector.
| Category | Detailed description |
|---|
| namespace | Custom namespace for custom metrics- A namespace is a logical separation used to distinguish and group metrics, designated as a custom metric for separating custom metrics
- A namespace must be 3 to 128 characters long, may include letters, numbers, spaces, and special characters (
-_/), and must start with a letter.
|
| accessKey | IAM authentication key Access Key |
| accessSecret | IAM authentication key Secret Key |
| resourceId | Resource ID of the server on Samsung Cloud Platform- Example: Resource ID of a Virtual Server
|
| openApiEndpoint | ServiceWatch OpenAPI endpoint per region/offering- Example: https://servicewatch.
region.offering.samsungsdscloud.com
region and offering information can be found in the Samsung Cloud Platform Console access URL
|
| telemetryPort | ServiceWatch Agent’s Telemetry Port- is typically used on port 8888. If port 8888 is in use, it needs to be changed
|
Table. agent.json configuration file entries
{
"namespace": "swagent-windows", # Custom namespace for user-defined metrics
"accessKey": "testKey", # IAM authentication key Access Key
"accessSecret": "testSecret", # IAM authentication key Secret Key
"resourceId": "resourceID", # Resource ID on the server's Samsung Cloud Platform
"openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com", # Region/Environment-specific ServiceWatch OpenAPI Endpoint
"telemetryPort": 8889 # ServiceWatch Agent's Telemetry Port (usually uses port 8888. If port 8888 is in use, change it)
}
{
"namespace": "swagent-windows", # Custom namespace for user-defined metrics
"accessKey": "testKey", # IAM authentication key Access Key
"accessSecret": "testSecret", # IAM authentication key Secret Key
"resourceId": "resourceID", # Resource ID on the server's Samsung Cloud Platform
"openApiEndpoint": "https://servicewatch.kr-west1.e.samsungsdscloud.com", # Region/Environment-specific ServiceWatch OpenAPI Endpoint
"telemetryPort": 8889 # ServiceWatch Agent's Telemetry Port (usually uses port 8888. If port 8888 is in use, change it)
}
Code block. Example of agent.json configurationDefines the metric configuration file for collecting metrics for ServiceWatch.
- If you want to collect metrics through the Agent, set up metric.json.
| Category | Detailed description |
|---|
| prometheus > scrape_configs > targets | Endpoint of the metric collection target- For servers, because the Prometheus Exporter is installed on the same machine, set it to that endpoint
|
| prometheus > scrape_configs > jobName | Set the Job Name. Usually set it to the type of Prometheus Exporter used for metric collection |
| metricMetas > metricName | Set the name of the metric to be collected. The metric name must be 3 to 128 characters long, include letters, numbers, and special characters (_), and start with a letter.- Example: node_cpu_seconds_total
|
| metricMetas > dimensions | Set the label of the Collector, among those provided to identify the source of the Exporter’s metric data, for visualization in the Console. When visualizing the collected metrics in the Console, combine them according to the dimensions setting.- Example: For metrics like the Memory Collector of Node Exporter that do not provide a special label, set it to resource_id.
- Example: The Filesystem Collector metrics of Node Exporter can have the mountpoint, which represents the path where the filesystem is mounted on the system, set as a dimension.
|
| metricMetas > unit | Metric unit can be set- Example: Bytes, Count, etc.
|
| metricMetas > aggregationMethod | Method to aggregate based on specified dimensions(dimensions)- Example: select from SUM, MAX, MIN, COUNT
|
| metricMetas > descriptionKo | Korean description of the metrics being collected |
| metricMetas > descriptionEn | English description of the metrics being collected |
Table. metric.json configuration file entries
{
"prometheus": {
"scrape_configs": {
"targets": [
"localhost:9100" # Endpoint of the Prometheus Exporter installed on the server
],
"jobName": "node-exporter" # Usually set to the name of the installed Exporter
}
},
"metricMetas": [
{
"metricName": "node_memory_MemTotal_bytes", # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
"dimensions": [
[
"resource_id" # Set the label used for visualizing in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
# If no specific label is provided, such as for the Memory-related metric, set it to **resource_id**.
]
],
"unit": "Bytes", # unit of the collected metric data
"aggregationMethod": "SUM", # aggregation method
"descriptionKo": "Total physical memory size of the server", # Korean description of the metric
"descriptionEn": "node memory total bytes" # English description of the metric
},
{
"metricName": "node_filesystem_size_bytes", # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
"dimensions": [
[
"mountpoint" # Set the label for visualizing in the Console among the Collector labels provided to identify the source of Node Exporter's metric data.
# Set the dimension (dimensions) of the Filesystem-related metric to the mountpoint, which indicates the path where the filesystem is mounted on the system.
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node filesystem size bytes"
"descriptionEn": "node filesystem size bytes"
},
{
"metricName": "node_memory_MemAvailable_bytes"
"dimensions": [
[
resource_id
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node memory available bytes"
"descriptionEn": "node memory available bytes"
},
{
"metricName": "node_filesystem_avail_bytes"
"dimensions": [
[
mountpoint
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node filesystem available bytes"
"descriptionEn": "node filesystem available bytes"
}
]
}
{
"prometheus": {
"scrape_configs": {
"targets": [
"localhost:9100" # Endpoint of the Prometheus Exporter installed on the server
],
"jobName": "node-exporter" # Usually set to the name of the installed Exporter
}
},
"metricMetas": [
{
"metricName": "node_memory_MemTotal_bytes", # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
"dimensions": [
[
"resource_id" # Set the label used for visualizing in the Console among the Collector's labels provided to identify the source of Node Exporter's metric data
# If no specific label is provided, such as for the Memory-related metric, set it to **resource_id**.
]
],
"unit": "Bytes", # unit of the collected metric data
"aggregationMethod": "SUM", # aggregation method
"descriptionKo": "Total physical memory size of the server", # Korean description of the metric
"descriptionEn": "node memory total bytes" # English description of the metric
},
{
"metricName": "node_filesystem_size_bytes", # Set the metric name to be linked with ServiceWatch among the metrics collected from the Prometheus Exporter
"dimensions": [
[
"mountpoint" # Set the label for visualizing in the Console among the Collector labels provided to identify the source of Node Exporter's metric data.
# Set the dimension (dimensions) of the Filesystem-related metric to the mountpoint, which indicates the path where the filesystem is mounted on the system.
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node filesystem size bytes"
"descriptionEn": "node filesystem size bytes"
},
{
"metricName": "node_memory_MemAvailable_bytes"
"dimensions": [
[
resource_id
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node memory available bytes"
"descriptionEn": "node memory available bytes"
},
{
"metricName": "node_filesystem_avail_bytes"
"dimensions": [
[
mountpoint
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "node filesystem available bytes"
"descriptionEn": "node filesystem available bytes"
}
]
}
Code block. metric.json configuration example - To display the resource name, set resource_name in commonLabels as shown below, and also set resource_name in metricMetas.dimensions; then ServiceWatch can retrieve the metric along with the resource name.
"commonLabels": {
"resource_name": "ResourceName" # Resource name visible in the User Console
},
"metricMetas": [
{
"metricName": "metric_name"
"dimensions": [
[
"resource_id"
"resource_name" # Add the resource_name set in commonLabels to the dimensions of each metric
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "metric_name description"
"descriptionEn": "metric_name description"
},
...
]
"commonLabels": {
"resource_name": "ResourceName" # Resource name visible in the User Console
},
"metricMetas": [
{
"metricName": "metric_name"
"dimensions": [
[
"resource_id"
"resource_name" # Add the resource_name set in commonLabels to the dimensions of each metric
]
],
"unit": "Bytes"
"aggregationMethod": "SUM"
"descriptionKo": "metric_name description"
"descriptionEn": "metric_name description"
},
...
]
Code block. metric.json - Resource name setting
Defines the log configuration file for collecting logs for ServiceWatch.
- If you want to collect logs, you must configure log.json.
| Category | Detailed description |
|---|
| fileLog > include | Location of log files to collect |
| fileLog > operators | Definition for parsing log messages to be collected |
| fileLog > operators > regex | Express the log message format as a regular expression |
| fileLog > operators > timestamp | The format of the Time Stamp of log messages to be sent to ServiceWatch |
| logMetas > log_group_value | Log group name created for sending logs to ServiceWatch |
| logMetas > log_stream_value | Log stream name in ServiceWatch log group |
Table. log.json configuration file entries
{
"fileLog": {
"include": [
"/var/log/syslog", # Log file to be collected by ServiceWatch
/var/log/auth.log
],
"operators": {
"regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$", # Represent log file format with a regular expression
"timestamp": { # Set the format of the log message's Time Stamp
"layout_type": "gotime"
"layout": "2006-01-02T15:04:05.000000Z07:00"
}
}
},
"logMetas": {
"log_group_value": "custom-log-group", # Log group name of ServiceWatch created in advance
"log_stream_value": "custom-log-stream" # Log stream name within the pre‑created ServiceWatch log group
}
}
{
"fileLog": {
"include": [
"/var/log/syslog", # Log file to be collected by ServiceWatch
/var/log/auth.log
],
"operators": {
"regex": "^(?P<timestamp>\\S+)\\s+(?P<hostname>\\S+)\\s+(?P<process>[^:]+):\\s+(?P<message>.*)$", # Represent log file format with a regular expression
"timestamp": { # Set the format of the log message's Time Stamp
"layout_type": "gotime"
"layout": "2006-01-02T15:04:05.000000Z07:00"
}
}
},
"logMetas": {
"log_group_value": "custom-log-group", # Log group name of ServiceWatch created in advance
"log_stream_value": "custom-log-stream" # Log stream name within the pre‑created ServiceWatch log group
}
}
Code block. log.json configuration example
Reference
To link a server’s log files to ServiceWatch via the ServiceWatch Agent, you must first create a log group and a log stream within that log group.
- For detailed information on creating log groups and log streams, refer to Log.
Running Open Telemetry Collector for ServiceWatch
How to Run ServiceWatch Agent
[ServiceWatch Agent executable] -action [run|stop] - dir [configuration file location] -collector [Open Telemetry Collector executable location]
| Execution options | Detailed description |
|---|
-action | Action setting (run or stop) |
-dir | the location of ServiceWatch Agent configuration files such as agent.json, metric.json, log.json |
-collector | Open Telemetry Collector executable file location |
Table. log.json configuration file entries
ServiceWatch Agent execution (for Linux)
Reference
agent.json, metric.json, log.json files are in current location/agent/examples/os-metrics-min-examples, and the otelcontribcol_linux_amd64 file is in current location/agent. Execute as shown below.
Run the ServiceWatch Agent.
- Check the locations of
agent.json, metric.json, log.json files and the locations of servicewatch-agent-manager-linux-amd64, otelcontribcol_linux_amd64 files, and start the ServiceWatch Agent../agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
Code block. ServiceWatch Agent start - collect all metrics/logs - If you only want to collect metrics, rename the
log.json file to a different name or move it so that it is not in the same directory as agent.json, metric.json, and then run as shown below../agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
Code block. ServiceWatch Agent start - collect metrics only - If you only want to collect logs, rename the
metric.json file to a different name or move it so that it is not in the same directory as agent.json, log.json, and run as shown below../agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
./agent/servicewatch-agent-manager-linux-amd64 -action run -dir ./agent/examples/os-metrics-min-examples -collector ./agent/otelcontribcol_linux_amd64
Code block. ServiceWatch Agent start - collect logs only
Stop the ServiceWatch Agent.
./agent/servicewatch-agent-manager-linux-amd64 -action stop -dir ./agent/examples/os-metrics-min-examples
./agent/servicewatch-agent-manager-linux-amd64 -action stop -dir ./agent/examples/os-metrics-min-examples
code block. Stop ServiceWatch Agent
Running ServiceWatch Agent (for Windows)
Run the ServiceWatch Agent.
servicewatch-agent-manager-windows-amd64.exe -action run -dir ./examples -collector otelcontribcol_windows_amd64.exe
servicewatch-agent-manager-windows-amd64.exe -action run -dir ./examples -collector otelcontribcol_windows_amd64.exe
code block. Start ServiceWatch AgentStop the ServiceWatch Agent.
servicewatch-agent-manager-windows-amd64.exe -action stop -dir ./examples
servicewatch-agent-manager-windows-amd64.exe -action stop -dir ./examples
code block. Stop ServiceWatch Agent