Merge branch 'splunk:main' into otel-collector-ja

Author: katzchang

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 5.15
+current_version = 5.31
 commit = True
 Tag = True
 parse = v?(?P<major>\d+)\.(?P<minor>\d+)

.github/ci/build_site

@@ -29,7 +29,7 @@ while getopts 'b:st:' opt; do
   esac
 done
 
-hugo --minify --destination "site/v${TAG_NAME}" --baseURL "${BASE_URL}observability-workshop/v$TAG_NAME"
+hugo --minify --destination "site/v${TAG_NAME}" --baseURL "${BASE_URL}observability-workshop/v$TAG_NAME" --noChmod
 
 if [[ $SERVE == 1 ]]; then
     if ! command -v "devd" &> /dev/null; then

.gitignore

@@ -50,3 +50,4 @@ workshop/aws/ec2/terraform.tfvars.save
 workshop/aws/ec2/terraform.tfvars.us1.1.pre copy.tfvars
 workshop/aws/ec2/*.conf
 workshop/aws/ec2/*.key
+workshop/aws/ec2/*.csv

README.md

@@ -1,14 +1,14 @@
 [![Deploy](https://github.com/splunk/observability-workshop/actions/workflows/deploy.yml/badge.svg)](https://github.com/splunk/observability-workshop/actions/workflows/deploy.yml)
 ![GitHub release (latest by date)](https://img.shields.io/github/v/tag/splunk/observability-workshop)
-![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/splunk/observability-workshop/latest)
+![GitHub commits since the latest release (by SemVer)](https://img.shields.io/github/commits-since/splunk/observability-workshop/latest)
 ![GitHub repo size](https://img.shields.io/github/repo-size/splunk/observability-workshop)
 ![GitHub issues](https://img.shields.io/github/issues/splunk/observability-workshop)
 
 # Splunk Observability Cloud Workshops
 
 ## Splunk Copyright Notice
 
-```
+``` text
 Copyright 2023 Splunk Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
@@ -23,5 +23,5 @@ Unless required by applicable law or agreed to in writing, software distributed
 To get started, please proceed to [The Splunk Observability Cloud Workshops Homepage](https://splunk.github.io/observability-workshop/latest/).
 
 Latest versions of the workshop are:
-- [v5.15](https://splunk.github.io/observability-workshop/v5.15/)
-- [v5.14](https://splunk.github.io/observability-workshop/v5.14/)
+- [v5.31](https://splunk.github.io/observability-workshop/v5.31/)
+- [v5.30](https://splunk.github.io/observability-workshop/v5.29/)

VERSION

@@ -1 +1 @@
-5.15
+5.31

content/en/imt/gdi/_index.md

@@ -108,28 +108,6 @@ REVISION: 1
 TEST SUITE: None
 ```
 
-{{% /tab %}}
-{{% tab title="Install Network Explorer" %}}
-
-```bash
-helm install splunk-otel-collector \
---set="splunkObservability.realm=$REALM" \
---set="splunkObservability.accessToken=$ACCESS_TOKEN" \
---set="clusterName=$(hostname)-k3s-cluster" \
---set="splunkObservability.logsEnabled=true" \
---set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
---set="networkExplorer.enabled=true" \
---set="networkExplorer.podSecurityPolicy.enabled=false" \
---set="agent.enabled=true" \
---set="gateway.replicaCount=1" \
---set="gateway.resources.limits.cpu=500m" \
---set="gateway.resources.limits.memory=1Gi" \
---set="clusterReceiver.enabled=true" \
---set="environment=$(hostname)-workshop" \
-splunk-otel-collector-chart/splunk-otel-collector \
--f ~/workshop/k3s/otel-collector.yaml
-```
-
 {{% /tab %}}
 {{< /tabs >}}
 

content/en/other/opentelemetry-collector/1-installation/1-confirmation.md

@@ -44,23 +44,13 @@ May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]:         {"kind": "exporter"
 {{% /tab %}}
 {{< /tabs >}}
 
-As will be running the rest of the workshop using the `otelcol-contrib` standalone binary, we will stop the service and then disable it from starting on boot:
+Because we will be making multiple configuration file changes, setting environment variables and restarting the collector, we need to stop the collector service and disable it from starting on boot.
 
 {{< tabs >}}
 {{% tab title="Command" %}}
 
 ``` bash
-sudo systemctl stop otelcol-contrib
-```
-
-{{% /tab %}}
-{{< /tabs >}}
-
-{{< tabs >}}
-{{% tab title="Command" %}}
-
-``` bash
-sudo systemctl disable otelcol-contrib
+sudo systemctl stop otelcol-contrib && sudo systemctl disable otelcol-contrib
 ```
 
 {{% /tab %}}
@@ -119,7 +109,7 @@ For this part we will require the following installed on your system:
 
 ## Why build your own collector?
 
-The default distribution of the collector (core and contrib) either contain too much or too little in what they have to offer.
+The default distribution of the collector (core and contrib) either contains too much or too little in what they have to offer.
 
 It is also not advised to run the contrib collector in your production environments due to the amount of components installed which more than likely are not needed by your deployment.
 
@@ -131,17 +121,17 @@ The benefits of this are:
 
 1. Smaller sized binaries
 2. Can use existing go scanners for vulnerabilities
-3. Include internal components that can tie in with your organisation
+3. Include internal components that can tie in with your organization
 
-## Considerations for building your own collector?
+## Considerations for building your collector?
 
-Now, this would not be a 🥷 Ninja zone if it didn't come with some draw backs:
+Now, this would not be a 🥷 Ninja zone if it didn't come with some drawbacks:
 
 1. Go experience is recommended if not required
 1. **No** Splunk support
-1. Responsibility of distribution and lifecycle management
+1. Responsibility for distribution and lifecycle management
 
-It is important to note that project is working towards stability but it does not mean changes made will not break your workflow. The team at Splunk provide increased support and a higher level of stability so they can provide a curated experience helping you with your deployment needs.
+It is important to note that the project is working towards stability but it does not mean changes made will not break your workflow. The team at Splunk provides increased support and a higher level of stability so they can provide a curated experience helping you with your deployment needs.
 
 ## The Ninja Zone
 
@@ -291,15 +281,15 @@ service:
 {{% /tab %}}
 {{< /tabs >}}
 
-Congratulations! You have successfully downloaded and installed the OpenTelemetry Collector. You are well on your way to becoming an OTel Ninja. But first lets walk through configuration files and different distributions of the OpenTelemetry Collector.
+Congratulations! You have successfully downloaded and installed the OpenTelemetry Collector. You are well on your way to becoming an OTel Ninja. But first let's walk through configuration files and different distributions of the OpenTelemetry Collector.
 
 {{% notice style="note" %}}
 
-Splunk does provide its own, fully supported, distribution of the OpenTelemetry Collector. This distribution is available to install from the [Splunk GitHub Repository](https://github.com/signalfx/splunk-otel-collector) or via a wizard in Splunk Observability Cloud that will build out a simple installation script to copy and paste. This distribution includes a number of additional features and enhancements that are not available in the OpenTelemetry Collector Contrib distribution.
+Splunk does provide its own, fully supported, distribution of the OpenTelemetry Collector. This distribution is available to install from the [**Splunk GitHub Repository**](https://github.com/signalfx/splunk-otel-collector) or via a wizard in Splunk Observability Cloud that will build out a simple installation script to copy and paste. This distribution includes many additional features and enhancements that are not available in the OpenTelemetry Collector Contrib distribution.
 
-- The Splunk Distribution of the OpenTelemetry Collector is production tested; it is in use by the majority of customers in their production environments.
-- Customers that use our distribution can receive direct help from official Splunk support within SLA's.
-- Customers can use or migrate to the Splunk Distribution of the OpenTelemetry Collector without worrying about future breaking changes to its core configuration experience for metrics and traces collection (OpenTelemetry logs collection configuration is in beta). There may be breaking changes to the Collector's own metrics.
+- The Splunk Distribution of the OpenTelemetry Collector is production-tested; it is in use by the majority of customers in their production environments.
+- Customers that use our distribution can receive direct help from official Splunk support within SLAs.
+- Customers can use or migrate to the Splunk Distribution of the OpenTelemetry Collector without worrying about future breaking changes to its core configuration experience for metrics and traces collection (OpenTelemetry logs collection configuration is in beta). There may be breaking changes to the Collector's metrics.
 
 {{% /notice %}}
 

content/en/other/opentelemetry-collector/1-installation/_index.md

@@ -6,9 +6,9 @@ weight: 1
 
 ## Download the OpenTelemetry Collector Contrib distribution
 
-The first step in installing the Open Telemetry Collector is downloading it. For our lab we will use the `wget` command to download the `.deb` package from the OpenTelemetry Github repository.
+The first step in installing the Open Telemetry Collector is downloading it. For our lab, we will use the `wget` command to download the `.deb` package from the OpenTelemetry Github repository.
 
-Obtain the `.deb` package for your platform from the [OpenTelemetry Collector Contrib releases page](https://github.com/open-telemetry/opentelemetry-collector-releases/releases)
+Obtain the `.deb` package for your platform from the [**OpenTelemetry Collector Contrib releases page**](https://github.com/open-telemetry/opentelemetry-collector-releases/releases)
 
 ``` bash
 wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.80.0/otelcol-contrib_0.80.0_linux_amd64.deb

content/en/other/opentelemetry-collector/2-extensions/1-health.md

@@ -36,7 +36,7 @@ otelcol-contrib --config=file:/etc/otelcol-contrib/config.yaml
 
 {{% /tab %}}
 
-This extension enables a HTTP URL that can be probed to check the status of the OpenTelemetry Collector. This extension can be used as a liveness and/or readiness probe on Kubernetes. To learn more about the `curl` command, check out the [curl man page](https://curl.se/docs/manpage.html).
+This extension enables an HTTP URL that can be probed to check the status of the OpenTelemetry Collector. This extension can be used as a liveness and/or readiness probe on Kubernetes. To learn more about the `curl` command, check out the [curl man page](https://curl.se/docs/manpage.html).
 
 Open a new terminal session and SSH into your instance to run the following command:
 

content/en/other/opentelemetry-collector/2-extensions/3-zpages.md

@@ -39,11 +39,11 @@ Example URL: [http://localhost:55679/debug/extensionz](http://localhost:55679/de
 {{% /tabs %}}
 
 {{% notice style="info" %}}
-If you are not following along, you can use your browser to access a test environment emitting zPages information at:
+You can use your browser to access your environment emitting zPages information at (replace `<insert_your_ip>` with your IP address):
 
-- **ServiceZ:** [http://63.33.64.193:55679/debug/servicez](http://63.33.64.193:55679/debug/servicez)
-- **PipelineZ:** [http://63.33.64.193:55679/debug/pipelinez](http://63.33.64.193:55679/debug/pipelinez)
-- **ExtensionZ:** [http://63.33.64.193:55679/debug/extensionz](http://63.33.64.193:55679/debug/extensionz)
+- **ServiceZ:** [http://<insert_your_ip>:55679/debug/servicez](http://<insert_your_ip>:55679/debug/servicez)
+- **PipelineZ:** [http://<insert_your_ip>:55679/debug/pipelinez](http://<insert_your_ip>:55679/debug/pipelinez)
+- **ExtensionZ:** [http://<insert_your_ip>:55679/debug/extensionz](http://<insert_your_ip>:55679/debug/extensionz)
 {{% /notice %}}
 
 ---