New topics - SRM get started #1197
Conversation
SudheendraKatte
added
Content - chore/cleanup
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
| sidebar_position: 10 | ||
| --- | ||
|
|
||
| The Harness Service Reliability Management (SRM) helps you improve the reliability of applications and services by providing real-time insights into their performance, detecting anomalies and providing automated remediation, and enabling you to quickly identify and resolve issues. |
There was a problem hiding this comment.
| The Harness Service Reliability Management (SRM) helps you improve the reliability of applications and services by providing real-time insights into their performance, detecting anomalies and providing automated remediation, and enabling you to quickly identify and resolve issues. | |
| Harness Service Reliability Management (SRM) helps you improve the reliability of applications and services by providing real-time insights into their performance, detecting anomalies, providing automated remediation, and enabling you to quickly identify and resolve issues. |
There was a problem hiding this comment.
Please search all occurrences of "the SRM"... it should just be SRM or Service Reliability Management.
There was a problem hiding this comment.
Incorporated
|
|
||
| - Performance Analytics: Provides detailed analytics and insights into the performance of your applications and services. This enables you to identify trends and make data-driven decisions to optimize performance of applications and services. | ||
|
|
||
| - Harness Service Reliability Management (SRM) module offers users the ability to define and configure Service Level Indicators (SLIs), Service Level Objectives (SLOs), and Error Budgets through a user-friendly GUI and APIs. |
There was a problem hiding this comment.
| - Harness Service Reliability Management (SRM) module offers users the ability to define and configure Service Level Indicators (SLIs), Service Level Objectives (SLOs), and Error Budgets through a user-friendly GUI and APIs. | |
| - **User-friendly GUI and APIs:** SRM offers users the ability to define and configure Service Level Indicators (SLIs), Service Level Objectives (SLOs), and Error Budgets through a user-friendly GUI and APIs. |
There was a problem hiding this comment.
Incorporated
|
|
||
| The main features of the SRM include: | ||
|
|
||
| - Real-time monitoring and alerting: Monitors the performance of your applications and infrastructure, providing real-time alerts when issues arise. |
There was a problem hiding this comment.
| - Real-time monitoring and alerting: Monitors the performance of your applications and infrastructure, providing real-time alerts when issues arise. | |
| - **Real-time monitoring and alerting:** Monitors the performance of your applications and infrastructure, providing real-time alerts when issues arise. |
There was a problem hiding this comment.
Incorporated
|
|
||
| - Real-time monitoring and alerting: Monitors the performance of your applications and infrastructure, providing real-time alerts when issues arise. | ||
|
|
||
| - Performance Analytics: Provides detailed analytics and insights into the performance of your applications and services. This enables you to identify trends and make data-driven decisions to optimize performance of applications and services. |
There was a problem hiding this comment.
| - Performance Analytics: Provides detailed analytics and insights into the performance of your applications and services. This enables you to identify trends and make data-driven decisions to optimize performance of applications and services. | |
| - **Performance Analytics:** Provides detailed analytics and insights into the performance of your applications and services. This enables you to identify trends and make data-driven decisions to optimize performance of applications and services. |
There was a problem hiding this comment.
Incorporated
|
|
||
| - Harness Service Reliability Management (SRM) module offers users the ability to define and configure Service Level Indicators (SLIs), Service Level Objectives (SLOs), and Error Budgets through a user-friendly GUI and APIs. | ||
| - | ||
| - Here is a brief introduction capabilities of Harness SRM. |
There was a problem hiding this comment.
| - Here is a brief introduction capabilities of Harness SRM. | |
| ## Summary of SRM capabilities | |
| The following table lists the main capabilities of SRM: | |
There was a problem hiding this comment.
Incorporated
|
|
||
| A Harness project is a group of Harness modules and resources. For example, a project might have a Harness SRM module to create an SLO. | ||
|
|
||
| To create a project, perform the following steps: |
There was a problem hiding this comment.
perform the following steps > "do the following" or "follow these steps" is more friendly/shorter.
There was a problem hiding this comment.
Opted for "do the following"
|
|
||
| The SLOs dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. | ||
|
|
||
| ## Navigate to the SLO dashboard |
There was a problem hiding this comment.
This is more of a step instruction, not a heading. Maybe: "## View the SLO dashboard"
There was a problem hiding this comment.
Incorporated
| sidebar_position: 30 | ||
| --- | ||
|
|
||
| The SLOs dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. |
There was a problem hiding this comment.
| The SLOs dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. | |
| The SLOs dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. |
| The SLOs dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. | |
| The SLO dashboard provides a centralized view to track, monitor, and manage all the SLOs set for your service, allowing you to easily gauge your service's overall health and performance. |
| - **Healthy**: number of SLOs which have a remaining error budget above 75%. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Instead of the 4 1st level headings below, make either a bullet list or 4 2nd level headings (and organize the heading for SLO details page accordingly).
| The SLO details page appears. | ||
|
|
||
|
|
||
| ### SLO details page |
There was a problem hiding this comment.
This might deserve its own 1st level heading (##)
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
There was a problem hiding this comment.
Looks much better, @SudheendraKatte. There's just some organization tweaks on create-first-slo and indentations here and there.
| - An Organization in Harness. If you have not already created one, go to [Create organizations and projects](/docs/platform/organizations-and-projects/create-an-organization.md). | ||
|
|
||
| - A project in Harness. If you have not already created one, follow these steps. | ||
|
|
There was a problem hiding this comment.
Indent the
There was a problem hiding this comment.
Tried indenting, but the folding text feature wont work :(
There was a problem hiding this comment.
When I indent the folding text feature won't work.
|
|
||
|
|
||
|
|
||
| ## Navigate to the "Create SLO" page |
There was a problem hiding this comment.
This shouldn't be a top level heading >> it's a step within a procedure. Also, we wouldn't put quotes around the page name.
There was a problem hiding this comment.
Maybe the procedure (at ## level) is Create a SLO. Then subheading levels (###):
## Create a SLO
Summary of high level steps:
- SLO identification...
- SLIs...
- Set our SLO
- (Optional) Error budget...
Define SLO Identification
- Go to [navigation path, for exampe SRM demo > SLOs...].
- In Define SLO Identification, enter a Name, etc....
- Follow the steps below to:
- Create a monitored service [link to below]
- Select a user journey [link to below]
Create a monitored service
Select a user journey
### Configure SLIs
### Set your SLO
etc...
| 11. In the **Create a Monitored Service** dialog, select **Save**. | ||
| The Monitored service appears in the **Monitored Service Name** field. | ||
|
|
||
| :::info note |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
| sidebar_position: 10 | ||
| --- | ||
|
|
||
| You can set up notifications for monitored services. This means that your team can receive alerts when any changes occur to a service's code, configuration, behavior, deployment, or infrastructure. These notifications can help keep your team informed and ensure that any issues are addressed quickly. |
There was a problem hiding this comment.
| You can set up notifications for monitored services. This means that your team can receive alerts when any changes occur to a service's code, configuration, behavior, deployment, or infrastructure. These notifications can help keep your team informed and ensure that any issues are addressed quickly. | |
| You can configure notifications for monitored services. Your team will receive alerts whenever there are modifications made to a service's code, configuration, behavior, deployment, or infrastructure. These notifications can help your team stay up to date and ensure that any problems are resolved promptly. |
|
|
||
| 2. In the Conditions page, select a condition to trigger a notification. You can add multiple conditions. The table below describes various conditions that you can set: | ||
|
|
||
| | Condition | Settings | |
There was a problem hiding this comment.
I would have used a note because MD tables are pretty fragile. You're braver than I am :)
| | **PagerDuty** | Enter the PagerDuty account or service key to the notifications should be sent. | | ||
| | **Microsoft Teams** | Enter the **Microsoft Teams Webhook URL(s)** to which the notifications should be sent. You add multiple Micorsoft webhook URLs by selecting **+ Add**. | | ||
|
|
||
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a **Project**, **Organization**, or an **Account**. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. |
There was a problem hiding this comment.
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a **Project**, **Organization**, or an **Account**. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. | |
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a Harness project, organization, or an account. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. |
There was a problem hiding this comment.
no need for capitalizing Harness entities like project. No need to bold then either. you might want to add a like to the user group notification docs instead of providing step that might need to be updated at some point.
|
|
||
| To set up notifications for a SLO: | ||
|
|
||
| 1. In your Harness project, navigate to **Service Reliability Management** > **SLOs**, and then select the SLO for which you want to set up notifications. |
There was a problem hiding this comment.
| 1. In your Harness project, navigate to **Service Reliability Management** > **SLOs**, and then select the SLO for which you want to set up notifications. | |
| 1. In your Harness project, navigate to **Service Reliability Management** > **SLOs**, and then select the SLO for notifications. |
|
|
||
| To set up notifications for a monitored service: | ||
|
|
||
| 1. In your Harness project, navigate to **Service Reliability Management** > **Monitored Services**, and then select the monitored service for which you want to configure notification. |
There was a problem hiding this comment.
| 1. In your Harness project, navigate to **Service Reliability Management** > **Monitored Services**, and then select the monitored service for which you want to configure notification. | |
| 1. In your Harness project, navigate to **Service Reliability Management** > **Monitored Services**, and then select the monitored service for notifications. |
| | **PagerDuty** | Enter the PagerDuty account or service key to the notifications should be sent. | | ||
| | **Microsoft Teams** | Enter the **Microsoft Teams Webhook URL(s)** to which the notifications should be sent. You add multiple Micorsoft webhook URLs by selecting **+ Add**. | | ||
|
|
||
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a **Project**, **Organization**, or an **Account**. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. |
There was a problem hiding this comment.
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a **Project**, **Organization**, or an **Account**. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. | |
| If you choose Slack, PagerDuty, or Microsoft Teams as your notification method, you can select a Harness user group that is part of a project, organization, or an account. Notifications are sent to the Slack or Microsoft Teams channels that are associated with the selected user group. |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app |
|
This PR was meant for getting the peer review of the content that changed as part of the SRM docs left nav reorg. Closing this PR as the all the new and updated content have been reviewed and approved (see the comments trail for review details). |
Harness Developer Pull Request
Thanks for helping us make the Developer Hub better. The PR will be looked at
by the maintainers.
What Type of PR is This?
If tied to an Issue, list the Issue(s) here:
House Keeping
Some items to keep track of. Screen shots of changes are optional but would help the maintainers review quicker.