diff --git a/content/en/imt/_index.md b/content/en/imt/_index.md index 30d386efd9..4e7a44ad5e 100644 --- a/content/en/imt/_index.md +++ b/content/en/imt/_index.md @@ -19,9 +19,9 @@ Here are the instructions on how to access your pre-configured [AWS](./initial-s ![Splunk Architecture](images/architecture.png) -[^1]: [Kubernetes](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/) is a portable, extensible, open-source platform for managing containerized workloads and services, that facilitates both declarative configuration and automation. -[^2]: The OpenTelemetry Collector offers a vendor-agnostic implementation on how to receive, process and export telemetry data. In addition, it removes the need to run, operate and maintain multiple agents/collectors to support open-source telemetry data formats (e.g. Jaeger, Prometheus, etc.) sending to multiple open-source or commercial back-ends. -[^3]: NGINX is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache. -[^4]: [Kubernetes ReplicaSet](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/) -[^5]: Jaeger, inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems -[^6]: [Monitoring as Code and Service Bureau](https://www.splunk.com/en_us/blog/it/monitoring-observability-enterprise-service.html) +[^1]: [**Kubernetes**](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/) is a portable, extensible, open-source platform for managing containerized workloads and services, that facilitates both declarative configuration and automation. +[^2]: [**OpenTelemetry Collector**](https://opentelemetry.io/) offers a vendor-agnostic implementation on how to receive, process and export telemetry data. In addition, it removes the need to run, operate and maintain multiple agents/collectors to support open-source telemetry data formats (e.g. Jaeger, Prometheus, etc.) sending to multiple open-source or commercial back-ends. +[^3]: [**NGINX**](https://www.nginx.com/) is a web server that can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache. +[^4]: [**Kubernetes ReplicaSet**](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/) +[^5]: [**Jaeger**](https://www.jaegertracing.io/), inspired by Dapper and OpenZipkin, is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems +[^6]: [**Monitoring as Code and Service Bureau**](https://www.splunk.com/en_us/blog/it/monitoring-observability-enterprise-service.html) diff --git a/content/en/imt/initial-setup.md b/content/en/imt/initial-setup.md index 3371e28955..ead7de3ee2 100644 --- a/content/en/imt/initial-setup.md +++ b/content/en/imt/initial-setup.md @@ -21,7 +21,7 @@ In preparation for the workshop, Splunk has prepared an Ubuntu Linux instance in To get access to the instance that you will be using in the workshop please visit the URL to access the Google Sheet provided by the workshop leader. -Search for your AWS/EC2 instance by looking for your first and last name, as provided during registration for this workshop. +Search for your AWS/EC2 instance by looking for your first and last name, as provided during registration for this workshop. ![attendee spreadsheet](../images/spreadsheet-info.png) @@ -30,7 +30,7 @@ Find your allocated IP address, SSH command (for Mac OS, Linux and the latest Wi It also has the Browser Access URL that you can use in case you cannot connect via ssh or putty - see [EC2 access via Web browser](#4-web-browser-all) {{% notice title="Important" style="info" %}} -Please use SSH or Putty to gain access to your EC2 instance if possible and +Please use SSH or Putty to gain access to your EC2 instance if possible and make a note of the IP address as you will need this during the workshop. {{% /notice %}} @@ -48,7 +48,7 @@ When prompted **`Are you sure you want to continue connecting (yes/no/[fingerpri Enter the password provided in the Google Sheet from Step #1. -Upon successful login you will be presented with the Splunk logo and the Linux prompt. +Upon successful login, you will be presented with the Splunk logo and the Linux prompt. ![ssh connected](../images/ssh-3.png) @@ -63,20 +63,20 @@ If you are shown a help text on how to use the ssh-command (like shown on the sc ![Windows SSH enabled](../images/windows-ssh-enabled-feedback.png) -If the result of executing the command looks something like on the screenshot below, you want to enable the "OpenSSH Client" feature manually. +If the result of executing the command looks something like the screenshot below, you want to enable the "OpenSSH Client" feature manually. ![Windows SSH disabled](../images/windows-ssh-disabled-feedback.png) -To do that, open the "Settings" menu, and click on "Apps". While being in the "Apps & features" section, click on "Optional features". +To do that, open the "Settings" menu, and click on "Apps". While in the "Apps & features" section, click on "Optional features". ![Windows Apps Settings](../images/windows-gui-optionalfeatures.png) -Here, you are presented a list of installed features. On the top, you see a button with a plus icon to "Add a feature". Click it. +Here, you are presented with a list of installed features. On the top, you see a button with a plus icon to "Add a feature". Click it. In the search input field, type "OpenSSH", and find a feature called "OpenSSH Client", or respectively, "OpenSSH Client (Beta)", click on it, and click the "Install"-button. ![Windows Enable OpenSSH Client](../images/windows-enable-openssh-client.png) -Now you are set! In case you are not able to access the provided instance in spite of enabling the OpenSSH feature, please do not shy away from reaching +Now you are set! In case you are not able to access the provided instance despite enabling the OpenSSH feature, please do not shy away from reaching out to the course instructor, either via chat or directly. At this point you are ready to continue and [start the workshop](../gdi/index.html) @@ -85,13 +85,13 @@ At this point you are ready to continue and [start the workshop](../gdi/index.ht ## 4. Putty (For Windows Versions prior to Windows 10) -If you do not have ssh pre-installed or if you are on a Windows system, the best option is to install putty, you can find [here.](https://www.putty.org/) +If you do not have SSH pre-installed or if you are on a Windows system, the best option is to install putty, you can find [here.](https://www.putty.org/) {{% notice title="Important" style="info" %}} If you **cannot** install Putty, please go to [Web Browser (All)](#4-web-browser-all). {{% /notice %}} -Open Putty and enter the in **Host Name (or IP address)** field the IP address provided in the Google Sheet. +Open Putty and enter in the **Host Name (or IP address)** field the IP address provided in the Google Sheet. You can optionally save your settings by providing a name and pressing **Save**. @@ -109,7 +109,7 @@ Once you are connected successfully you should see a screen similar to the one b ![putty-4](../images//putty-loggedin.png) -At this point you are ready to continue and [start the workshop](../gdi/index.html) +At this point, you are ready to continue and [start the workshop](../gdi/index.html) --- @@ -135,7 +135,7 @@ Once you are connected successfully you should see a screen similar to the one b Unlike when you are using regular SSH, *copy and paste* does require a few extra steps to complete when using a browser session. This is due to cross browser restrictions. -When the workshop ask you to copy instructions into your terminal, please do the following: +When the workshop asks you to copy instructions into your terminal, please do the following: *Copy the instruction as normal, but when ready to paste it in the web terminal, choose **Paste from browser** as show below:* @@ -145,10 +145,10 @@ This will open a dialogue box asking for the text to be pasted into the web term ![web paste 3](../images//shellinabox-example-1.png) -Paste the text in the text box as show, then press **OK** to complete the copy and paste process. +Paste the text in the text box as shown, then press **OK** to complete the copy and paste process. {{% notice title="Note" style="info" %}} -Unlike regular SSH connection, the web browser has a 60 second time out, and you will be disconnected, and a **Connect** button will be shown in the center of the web terminal. +Unlike regular SSH connection, the web browser has a 60-second time out, and you will be disconnected, and a **Connect** button will be shown in the center of the web terminal. Simply click the **Connect** button and you will be reconnected and will be able to continue. {{% /notice %}} @@ -161,6 +161,6 @@ At this point you are ready to continue and [start the workshop](../gdi/index.ht ## 6. Multipass (All) -If you are unable to access AWS, but you want to install software locally, follow the instructions for [using Multipass](https://github.com/splunk/observability-workshop/blob/main/multipass/README.md). +If you are unable to access AWS, but want to install software locally, follow the instructions for [using Multipass](https://github.com/splunk/observability-workshop/blob/main/multipass/README.md). [^1]: [Download Putty](https://www.chiark.greenend.org.uk/~sgtatham/putty/) diff --git a/content/en/imt/servicebureau/_index.md b/content/en/imt/servicebureau/_index.md index 2a0f3cac86..836a8d28b0 100644 --- a/content/en/imt/servicebureau/_index.md +++ b/content/en/imt/servicebureau/_index.md @@ -16,9 +16,9 @@ weight: 6 ## 1. Understanding engagement -To fully understand Observability Cloud engagement inside your organization, click on the **>>** bottom left and select the **Settings → Organization Overview**, this will provide you with the following dashboards that shows you how your Observability Cloud organization is being used: +To fully understand Observability Cloud engagement inside your organization, click on the **>>** bottom left and select the **Settings → Organization Overview**, this will provide you with the following dashboards that show you how your Observability Cloud organization is being used: -![Organization overview](../images/engagement.png) +![Organization Overview](../images/engagement.png) You will see various dashboards such as Throttling, System Limits, Entitlements & Engagement. The workshop organization you're using now may have less data to work with as this is cleared down after each workshop. @@ -46,9 +46,9 @@ For more information about these categories please refer to [Monitor Splunk Infr The top chart shows you the current subscription levels per category (shown by the red arrows at the top in the screenshot below). -Also, your current usage of the four catagories is displayed (shown at the red lines at the bottom of the chart). +Also, your current usage of the four categories is displayed (shown in the red lines at the bottom of the chart). -In this example you can see that there are 25 Hosts, 0 Containers, 100 Custom Metrics and 0 High Resolution Metrics. +In this example, you can see that there are 25 Hosts, 0 Containers, 100 Custom Metrics and 0 High Resolution Metrics. ![Billing and Usage-top](../images/usage-detail.png) @@ -62,7 +62,7 @@ The blue line marked **Average Usage** indicates what Observability Cloud will u As you can see from the screenshot, Observability Cloud does not use High Watermark or P95% for cost calculation but the actual average hourly usage, allowing you to do performance testing or Blue/Green style deployments etc. without the risk of overage charges. {{% /notice %}} -To get a feel for the options you can change the metric displayed by selecting the different options from the **Usage Metric** drop down on the left, or change the **Subscription Usage Period** with the drop down on the right. +To get a feel for the options you can change the metric displayed by selecting the different options from the **Usage Metric** drop-down on the left, or change the **Subscription Usage Period** with the drop-down on the right. Please take a minute to explore the different time periods & categories and their views. diff --git a/content/en/imt/servicebureau/teams.md b/content/en/imt/servicebureau/teams.md index dbe8387487..ad103bc982 100644 --- a/content/en/imt/servicebureau/teams.md +++ b/content/en/imt/servicebureau/teams.md @@ -5,7 +5,7 @@ weight: 1 --- * Introduction to Teams -* Create a Team and add members to Team +* Create a Team and add members to the Team --- @@ -13,7 +13,7 @@ weight: 1 To make sure that users see the dashboards and alerts that are relevant to them when using Observability Cloud, most organizations will use Observability Cloud's Teams feature to assign a member to one or more Teams. -Ideally, this matches work related roles, for example, members of a Dev-Ops or Product Management group would be assigned to the corresponding Teams in Observability Cloud. +Ideally, this matches work-related roles, for example, members of a Dev-Ops or Product Management group would be assigned to the corresponding Teams in Observability Cloud. When a user logs into Observability Cloud, they can choose which Team Dashboard will be their home page and they will typically select the page for their primary role. @@ -21,19 +21,19 @@ In the example below, the user is a member of the Development, Operations and Pr This Dashboard has specific Dashboard Groups for Usage, SaaS and APM Business Workflows assigned but any Dashboard Group can be linked to a Teams Dashboard. -They can use the menu along the top left to quickly navigate between their allocated teams, or they can use the **ALL TEAMS** dropdown on the right to select specific Team Dashboards, as well as quickly accessing **ALL Dashboards** using the adjacent link. +They can use the menu along the top left to quickly navigate between their allocated teams, or they can use the **ALL TEAMS** dropdown on the right to select specific Team Dashboards, as well as quickly access **ALL Dashboards**** using the adjacent link. ![Teams](../../images/teams-homepage.png) -Alerts can be linked to specific Teams so the Team can monitor only the Alerts they are interested in, and in the above example they currently have 1 active Critical Alert. +Alerts can be linked to specific Teams so the Team can monitor only the Alerts they are interested in, and in the above example, they currently have 1 active Critical Alert. -The Description for the Team Dashboard can be customized and can include links to team specific resources (using Markdown). +The Description for the Team Dashboard can be customized and can include links to team-specific resources (using Markdown). --- ## 2. Creating a new Team -To work with to Splunk's Team UI click on the hamburger icon top left and select the **Organizations Settings → Teams**. +To work with Splunk's Team UI click on the hamburger icon top left and select the **Organizations Settings → Teams**. When the **Team** UI is selected you will be presented with the list of current Teams. @@ -49,7 +49,7 @@ You can remove selected users by pressing **Remove** or the small **x**. Make sure you have your group created with your initials and with yourself added as a member, then click {{% button style="blue" %}}Done{{% /button %}} -This will bring you back to the **Teams** list that will now show your Team and the one's created by others. +This will bring you back to the **Teams** list that will now show your Team and the ones created by others. {{% notice title="Note" style="info" %}} The Teams(s) you are a member of have a grey **Member** icon in front of it. @@ -65,11 +65,11 @@ The **...** menu gives you the option to Edit, Join, Leave or Delete a Team (lea ## 3. Adding Notification Rules -You can set up specific Notification rules per team, click on the **Notification Policy** tab, this will open the notification edit menu. +You can set up specific Notification rules per team, by clicking on the **Notification Policy** tab, this will open the notification edit menu. ![Base notification menu](../../images/notification-policy.png) -By default the system offers you the ability to set up a general notification rule for your team. +By default, the system offers you the ability to set up a general notification rule for your team. {{% notice title="Note" style="info" %}} The **Email all team members** option means all members of this Team will receive an email with the Alert information, regardless of the alert type. @@ -79,13 +79,13 @@ The **Email all team members** option means all members of this Team will receiv You can add other recipients, by clicking {{% button style="blue" %}}Add Recipient{{% /button %}}. These recipients do not need to be Observability Cloud users. -However if you click on the link **Configure separate notification tiers for different severity alerts** you can configure every alert level independently. +However, if you click on the link **Configure separate notification tiers for different severity alerts** you can configure every alert level independently. ![Multiple Notifications](../../images/single-policy.png) Different alert rules for the different alert levels can be configured, as shown in the above image. -Critical and Major are using [Splunk\'s On-Call](https://www.splunk.com/en_us/observability/on-call.html) Incident Management solution. For the Minor alerts we send it to the Teams Slack channel and for Warning and Info we send an email. +Critical and Major are using [Splunk\'s On-Call](https://www.splunk.com/en_us/observability/on-call.html) Incident Management solution. For the Minor alerts, we send it to the Teams Slack channel and for Warning and Info we send an email. ### 3.2 Notification Integrations @@ -93,4 +93,4 @@ In addition to sending alert notifications via email, you can configure Observab ![Notifications options](../../images/integrations.png) -Take a moment to create some notification rules for you Team. +Take a moment to create some notification rules for your Team. diff --git a/content/en/imt/servicebureau/tokens.md b/content/en/imt/servicebureau/tokens.md index e163ba0aa6..38140ff617 100644 --- a/content/en/imt/servicebureau/tokens.md +++ b/content/en/imt/servicebureau/tokens.md @@ -4,7 +4,7 @@ linkTitle: 6.2 Control Usage weight: 2 --- -* Discover how you can restrict usage by creating separate Access Tokens and set limits. +* Discover how you can restrict usage by creating separate Access Tokens and setting limits. ## 1. Access Tokens @@ -12,9 +12,9 @@ If you wish to control the consumption of Hosts, Containers, Custom Metrics and In the UI click on the **>>** bottom left and select the **Settings → Access Tokens** under **General Settings**. -The **Access Tokens** Interface provides an overview of your allotments in the form of a list of Access Tokens that have been generated. Every Organization will have a **Default** token generated when they are first setup, but there will typically be multiple Tokens configured. +The **Access Tokens** Interface provides an overview of your allotments in the form of a list of Access Tokens that have been generated. Every Organization will have a **Default** token generated when they are first set up, but there will typically be multiple Tokens configured. -Each Token is unique and can be assigned limits for the amount of Hosts, Containers, Custom Metrics and High Resolution Metrics it can consume. +Each Token is unique and can be assigned limits for the number of Hosts, Containers, Custom Metrics and High Resolution Metrics it can consume. The **Usage Status** Column quickly shows if a token is above or below its assigned limits. @@ -44,7 +44,7 @@ If you need to make sure a token cannot be used to send Metrics in you can disab Click on **Disable** to disable the token, this means the token cannot be used for sending in data to Splunk Observability Cloud. -The line with your token should have become greyed out to indicate that is has been disabled as you can see in the screenshot below. +The line with your token should have become greyed out to indicate that it has been disabled as you can see in the screenshot below. ![Token disabled](../../images/disable-access-token.png) @@ -52,13 +52,13 @@ Go ahead and click on the ellipsis (**...**) menu button to Disable and Enable y ## 4. Manage token usage limits -Now Lets start limiting usage by clicking on Manage Token Limit in the 3 **...** menu. +Now, let's start limiting usage by clicking on Manage Token Limit in the 3 **...** menu. This will show the Manage Token Limit Dialog: ![Set Limits on token](../../images/manage-token-limit.png) -In this Dialog you can set the limits per category. +In this dialog, you can set the limits per category. Please go ahead and specify the limits as follows for each usage metric: @@ -69,18 +69,18 @@ Please go ahead and specify the limits as follows for each usage metric: | Custom Metric Limit | 20 | | High Resolution Metric Limit | 0 | -For our lab use your own email address, and double check that you have the correct numbers in your dialog box as shown in the table above. +For our lab use your email address, and double check that you have the correct numbers in your dialog box as shown in the table above. -Token limits are used to trigger an alert that notify one or more recipients when the usage has been above 90% of the limit for 5 minutes. +Token limits are used to trigger an alert that notifies one or more recipients when the usage has been above 90% of the limit for 5 minutes. To specify the recipients, click {{% button style="blue" %}}Add Recipient{{% /button %}}, then select the recipient or notification method you want to use (specifying recipients is optional but highly recommended). -The severity for token alerts is always Critical. +The severity of token alerts is always Critical. Click on {{% button style="blue" %}}Update{{% /button %}} to save your Access Tokens limits and The Alert Settings. {{% notice title="Note: Going above token limit" style="info" %}} -When a token is at or above its limit in a usage category, new metrics for that usage category will not be stored and processed by Observability Cloud. This will make sure you there will be no unexpected cost due to a team sending in data without restriction. +When a token is at or above its limit in a usage category, new metrics for that usage category will not be stored and processed by Observability Cloud. This will make sure there will be no unexpected cost due to a team sending in data without restriction. {{% /notice %}} {{% notice title="Note: Advanced alerting" style="info" %}} @@ -89,6 +89,6 @@ If you wish to get alerts before you hit 90%, you can create additional detector In your company you would distribute these new Access Tokens to various teams, controlling how much information/data they can send to Observability Cloud. -This will allow you to fine tune the way you consume your Observability Cloud allotment and prevent overages from happening. +This will allow you to fine-tune the way you consume your Observability Cloud allotment and prevent overages from happening. -**Congratulations!** You have now have completed the Service Bureau module. +**Congratulations!** You have now completed the Service Bureau module. diff --git a/content/en/other/hpa/6-setup-hpa.md b/content/en/other/hpa/6-setup-hpa.md index 3726123f55..f8f27ea094 100644 --- a/content/en/other/hpa/6-setup-hpa.md +++ b/content/en/other/hpa/6-setup-hpa.md @@ -48,7 +48,7 @@ spec: name: php-apache ``` -Once deployed, `php-apache` will autoscale when either the average CPU usage goes above 50% and the average memory usage for the deployment goes above 75%, with a minimum of 1 pod and a maximum of 4 pods. +Once deployed, `php-apache` will autoscale when either the average CPU usage goes above 50% or the average memory usage for the deployment goes above 75%, with a minimum of 1 pod and a maximum of 4 pods. ``` text kubectl apply -f ~/workshop/k3s/hpa.yaml @@ -90,4 +90,4 @@ Save the changes you have made. (Hint: Use `Esc` followed by `:wq!` to save your {{% /notice %}} -**Congratulations!** You have successfully completed the workshop. +**Congratulations!** You have completed the workshop.