Remove command-c

rcastley · rcastley · commit ad0a2e3447d0 · 2025-02-05T15:40:37.000Z
diff --git a/content/en/ninja-workshops/10-advanced-otel/1-agent/1-3-fileexporter/1-test-fileexporter.md b/content/en/ninja-workshops/10-advanced-otel/1-agent/1-3-fileexporter/1-test-fileexporter.md
@@ -42,7 +42,7 @@ You should now see a file named `agent.out` in the current directory. Since no m
 {{% /tab %}}
 
 {{% notice note %}}
-On **Windows**, an open file may appear empty or cause issues when attempting to read it. To prevent this, make sure to stop the **Agent** or the `gateway` before inspecting the file, as instructed.
+On **Windows**, an open file may appear empty or cause issues when attempting to read it. To prevent this, make sure to stop the **Agent** or the **Gateway** before inspecting the file, as instructed.
 {{% /notice %}}
 
 The span is written to the `agent.out` as a single line in OTLP/JSON format:
diff --git a/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-2-prepare_agent.md b/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-2-prepare_agent.md
@@ -6,7 +6,7 @@ weight: 2
 
 ### Test Gateway
 
-Open a third terminal window, this one will be used to run the `gateway` and navigate to the`[WORKSHOP]/2-gateway` directory and run the following command to test the gateway configuration:
+Open a third terminal window, this one will be used to run the **Gateway** and navigate to the`[WORKSHOP]/2-gateway` directory and run the following command to test the gateway configuration:
 
 ```text
 ../otelcol --config=gateway.yaml
diff --git a/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-2-test-gateway.md b/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-2-test-gateway.md
@@ -0,0 +1,100 @@
+---
+title: 2.2 Test the gateway and prepare the agent
+linkTitle: 2.2 Test Gateway & Configure Agent
+weight: 2
+---
+
+### Test Gateway
+
+Open a third terminal window, this one will be used to run the **Gateway** and navigate to the`[WORKSHOP]/2-gateway` directory and run the following command to test the gateway configuration:
+
+```text
+../otelcol --config=gateway.yaml
+```
+
+If everything is set up correctly, the first and last lines of the output should look like:
+
+```text
+2025/01/15 15:33:53 settings.go:478: Set config to [gateway.yaml]
+<snip to the end>
+2025-01-13T12:43:51.747+0100 info service@v0.116.0/service.go:261 Everything is ready. Begin running and processing data.
+```
+
+---
+
+### Update Agent Configuration
+
+Select your **Agent** terminal window, and also navigate to the `[WORKSHOP]/2-gateway` directory.  
+Open the `agent.yaml` we copied earlier in your editor, and configure a `otlphttp` exporter by replacing the existing `file` exporter. (this is now the preferred exporter for Splunk Observability Cloud):
+
+{{% notice title="Exercise" style="green" icon="running" %}}
+
+- **Configure the `otlphttp` exporter**: Ensure the `endpoint` is set to the gateway endpoint and add the `X-SF-Token` header with a Splunk Access Token.
+
+  ```yaml
+    otlphttp:
+      endpoint: "http://localhost:5318" # Gateway endpoint
+      headers:
+        X-SF-Token: "A_ACCESS_TOKEN"    # New way to set an Splunk ACCESS_TOKEN
+  ```
+
+- **Add a batch processor to the agent**: since the agent can send data from different sources, and benefit from retries, adding a Batch processor is useful too:
+
+  ```yaml
+    batch:                              # Processor Type
+      metadata_keys: [X-SF-Token]       # Array of metadata keys to batch 
+  ```
+
+- **Update Pipelines**: replace the `file:` exporter with the `otlphttp` exporter in the `traces`, `metrics`, and `logs` pipelines. Also, add the `hostmetrics` receiver to the `metrics` pipeline.
+
+  ```yaml
+     #traces:
+     metrics:
+      receivers: 
+      - otlp                        # OTLP Receiver
+      - hostmetrics                 # Hostmetrics Receiver
+      processors:
+      - memory_limiter              # Memory Limiter Processor
+      - resourcedetection           # Adds system attributes to the data
+      - resource/add_mode           # Adds collector mode metadata
+      - batch                       # Batch Processor, groups data before send
+      exporters:
+      - debug                       # Debug Exporter 
+      - otlphttp                    # OTLP/HTTP EXporter used by Splunk O11Y
+      # logs:
+  ```
+
+{{% /notice %}}  
+Again, validate the agent configuration using **[otelbin.io](https://www.otelbin.io/)**. For reference, this is the visualization for the `metrics` pipeline:
+
+```mermaid
+%%{init:{"fontFamily":"monospace"}}%%
+graph LR
+    %% Nodes
+      REC1(hostmetrics<br>fa:fa-download):::receiver
+      REC2(&nbsp;&nbsp;&nbsp;&nbsp;otlp&nbsp;&nbsp;&nbsp;&nbsp;<br>fa:fa-download):::receiver
+      PRO1(memory_limiter<br>fa:fa-microchip):::processor
+      PRO2(resourcedetection<br>fa:fa-microchip):::processor
+      PRO3(resource<br>fa:fa-microchip):::processor
+      PRO4(batch<br>fa:fa-microchip):::processor
+      EXP1(otlphttp<br>fa:fa-upload):::exporter
+      EXP2(&ensp;debug&ensp;<br>fa:fa-upload):::exporter
+    %% Links
+    subID1:::sub-metrics
+    subgraph " "
+      subgraph subID1[**Metrics**]
+      direction LR
+      REC1 --> PRO1
+      REC2 --> PRO1
+      PRO1 --> PRO2
+      PRO2 --> PRO3
+      PRO3 --> PRO4
+      PRO4 --> EXP1
+      PRO4 --> EXP2
+      end
+    end
+classDef receiver,exporter fill:#8b5cf6,stroke:#333,stroke-width:1px,color:#fff;
+classDef processor fill:#6366f1,stroke:#333,stroke-width:1px,color:#fff;
+classDef con-receive,con-export fill:#45c175,stroke:#333,stroke-width:1px,color:#fff;
+classDef sub-metrics stroke:#38bdf8,stroke-width:1px, color:#38bdf8,stroke-dasharray: 3 3;
+```
diff --git a/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-3-test-agent-gateway.md b/content/en/ninja-workshops/10-advanced-otel/2-gateway/2-3-test-agent-gateway.md
@@ -290,7 +290,7 @@ After executing the command, the gateway should generate a new file named `./gat
 {{% /tabs %}}
 
 {{% notice title="Tip" style="primary" icon="lightbulb" %}}
-Ensure that both `./gateway-metrics.out` and `./gateway-traces.out` include a resource attribute key-value pair for `otelcol.service.mode` with the value `gateway`.
+Ensure that both `./gateway-metrics.out` and `./gateway-traces.out` include a resource attribute key-value pair for `otelcol.service.mode` with the value **Gateway**.
 
 In the provided `gateway.yaml` configuration, we modified the `resource/add_mode` processor to use the `upsert` action instead of `insert`. The `upsert` action updates the value of the resource attribute key if it already exists, setting it to `"gateway"`. If the key is not present, the `upsert` action will add it.
 {{% /notice %}}
diff --git a/content/en/ninja-workshops/10-advanced-otel/3-filelog/3-2-test-filelog.md b/content/en/ninja-workshops/10-advanced-otel/3-filelog/3-2-test-filelog.md
@@ -207,4 +207,4 @@ This feature is designed to help users quickly identify and investigate issues b
 You may have noticed that every log line contains empty placeholders for `"traceId":""` and `"spanId":""`. The Filelog receiver will populate these fields only if they are not already present in the log line. For example, if the log line is generated by an application instrumented with an OpenTelemetry instrumentation library, these fields will already be included and will not be overwritten.
 {{% /notice %}}
 
-Stop the Agent, Gateway and the Quotes generating script as well using `Command-c/Ctrl-c`.
+Stop the Agent, Gateway and the Quotes generating script as well using `Ctrl-C`.
diff --git a/content/en/ninja-workshops/10-advanced-otel/4-resilience/4-1-test-resilience.md b/content/en/ninja-workshops/10-advanced-otel/4-resilience/4-1-test-resilience.md
@@ -6,12 +6,12 @@ weight: 1
 
 ### Setup Test environment
 
-In this section we are going to simulate an outage on the network between the **Agent** and the `gateway` and see if our configuration helps the Collector recover from that issue:
+In this section we are going to simulate an outage on the network between the **Agent** and the **Gateway** and see if our configuration helps the Collector recover from that issue:
 
 {{% notice title="Exercise" style="green" icon="running" %}}
 
 **Run the Gateway**:
-Find your `Gateway` terminal window, and navigate to the `[WORKSHOP]/4-resilience` directory and restart the gateway.
+Find your **Gateway** terminal window, and navigate to the `[WORKSHOP]/4-resilience` directory and restart the gateway.
 
 It should start up normally and state : `Everything is ready. Begin running and processing data.`
 
@@ -31,20 +31,20 @@ If everything is working as expected, we can move on to testing the system’s r
 
 ### Testing System Resilience
 
-To evaluate the system’s resilience, we’ll simulate a scenario where the Gateway becomes temporarily unreachable by stopping it and observing how the system responds. First, we’ll generate traffic to the agent by sending some traces. Since the Gateway is down, the agent will enter retry mode.  Once we restart the agent, it will recover the traces from the persistent queue and successfully send them to the Gateway. Without the persistent queue, these traces would have been lost permanently.
+To evaluate the system’s resilience, we’ll simulate a scenario where the **Gateway** becomes temporarily unreachable by stopping it and observing how the system responds. First, we’ll generate traffic to the agent by sending some traces. Since the **Gateway** is down, the agent will enter retry mode.  Once we restart the agent, it will recover the traces from the persistent queue and successfully send them to the Gateway. Without the persistent queue, these traces would have been lost permanently.
 
 {{% notice title="Exercise" style="green" icon="running" %}}
 Let's start our "network failure":
 
 **Simulate a Network Failure**:
-Stop the Gateway with `Command-c/Ctrl-c` and wait until the gateway console shows that it has stopped:
+Stop the **Gateway** with `Ctrl-C` and wait until the gateway console shows that it has stopped:
 
 ```text
 2025-01-28T13:24:32.785+0100  info  service@v0.116.0/service.go:309  Shutdown complete.
 ```
 
 **Create Traffic during the "Network Failure"**:  
-While the Gateway is stopped, send 3–4 traces using the cURL command we used earlier.
+While the **Gateway** is stopped, send 3–4 traces using the cURL command we used earlier.
 
 Notice that the agent’s retry mechanism is activated as it continuously attempts to resend the data. In the agent’s console output, you will see repeated messages similar to the following:
 
@@ -72,10 +72,10 @@ This step is essential for clearly observing the recovery process when the agent
 Restart the Gateway. It should initialize as expected and be ready and waiting to receive data.
 
 **Restart the Agent**
-Once the `gateway` is up and running, restart the **Agent**. It will resume sending data from the last checkpointed state, ensuring no data is lost. You should see the `gateway` begin receiving the previously missed traces without requiring any additional action on your part.
+Once the **Gateway** is up and running, restart the **Agent**. It will resume sending data from the last checkpointed state, ensuring no data is lost. You should see the **Gateway** begin receiving the previously missed traces without requiring any additional action on your part.
 
 {{% notice title="Tip" style="primary" icon="lightbulb" %}}
-Note that only the `gateway` will show that the checkpointed traces have arrived. The agent will not display any indication that data new or old has been sent.
+Note that only the **Gateway** will show that the checkpointed traces have arrived. The agent will not display any indication that data new or old has been sent.
 {{% /notice %}}
 {{% /notice %}}
 
@@ -87,4 +87,4 @@ By implementing file-based checkpointing and queue persistence, you ensure the t
 
 If you want to know more about the `FileStorage` extension, you can find it [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/filestorage)
 
-Stop the **Agent** and `gateway` using Command-c/Ctrl-c.
+Stop the **Agent** and **Gateway** using Ctrl-C.
diff --git a/content/en/ninja-workshops/10-advanced-otel/5-dropping-spans/5-1-test-filter-processor.md b/content/en/ninja-workshops/10-advanced-otel/5-dropping-spans/5-1-test-filter-processor.md
@@ -69,9 +69,9 @@ Copy the following JSON and save to a file called `health.json` in the `5-droppi
 {{% /tab %}}
 {{% /tabs %}}
 
-Ensure that both the **Agent** and `gateway` are started from the `[WORKSHOP]/5-dropping-spans` directory using their respective configuration.yaml files. Next, update and use the **cURL** command we used earlier to send the `health.json` payload.
+Ensure that both the **Agent** and **Gateway** are started from the `[WORKSHOP]/5-dropping-spans` directory using their respective configuration.yaml files. Next, update and use the **cURL** command we used earlier to send the `health.json` payload.
 
-Once the `span` payload is sent, the agent will process it, which you can confirm by checking the agent’s debug output to see the span data. The **Agent** will then forward the span to the `gateway`. However, because the `gateway` is configured with a filter to drop spans named `"/_healthz"`, the span will be discarded and not processed further.
+Once the `span` payload is sent, the agent will process it, which you can confirm by checking the agent’s debug output to see the span data. The **Agent** will then forward the span to the **Gateway**. However, because the **Gateway** is configured with a filter to drop spans named `"/_healthz"`, the span will be discarded and not processed further.
 
 The gateway console will remain unchanged, showing no indication that the data was received or handled.
 
@@ -115,4 +115,4 @@ This will drop spans with the names `"/_healthz"` and `"/internal/metrics"`.
 
 You can further extend this configuration to filter out spans based on different attributes, tags, or other criteria, making the OpenTelemetry Collector more customizable and efficient for your observability needs.
 
-Stop the **Agent** and `gateway` using Command-c/Ctrl-c.
+Stop the **Agent** and **Gateway** using Ctrl-C.
diff --git a/content/en/ninja-workshops/10-advanced-otel/6-sensitive-data/6-1-test-delete-tag.md b/content/en/ninja-workshops/10-advanced-otel/6-sensitive-data/6-1-test-delete-tag.md
@@ -6,15 +6,15 @@ weight: 1
 
 ### Test the Attribute Processor tag updates
 
-Restart your `gateway` terminal window, and wait until it is ready to receive data.
+Restart your **Gateway** terminal window, and wait until it is ready to receive data.
 
 {{% notice title="Exercise" style="green" icon="running" %}}
 In this exercise, we will **delete** the `user.account_password`, **update** the `user.phone_number` **attribute** & **hash** the `user.email` in the span data before it is exported by the **Agent**.
 
 - **Disable the `redaction/redact` processor** in the `traces` pipeline by adding the comment character `#` in front of it.
 - **Start the **Agent** Collector** from the **Agent** terminal window.
 - **Send a span containing `Sensitive data`** by running the **cURL** command to send `trace.json`.
-- **Check the debug output** of both the **Agent** and `Gateway` to confirm that `user.account_password` has been removed, and both `user.phone_number` & `user.email` have been updated.
+- **Check the debug output** of both the **Agent** and **Gateway** to confirm that `user.account_password` has been removed, and both `user.phone_number` & `user.email` have been updated.
 {{% tabs %}}
 {{% tab title="New Debug Output" %}}
 
@@ -143,4 +143,4 @@ In this exercise, we will **delete** the `user.account_password`, **update** the
 {{% /tabs %}}
 
 {{% /notice %}}
-Stop the **Agent** and `gateway` using Command-c/Ctrl-c.
+Stop the **Agent** and **Gateway** using Ctrl-C.
diff --git a/content/en/ninja-workshops/10-advanced-otel/6-sensitive-data/6-2-test-redaction.md b/content/en/ninja-workshops/10-advanced-otel/6-sensitive-data/6-2-test-redaction.md
@@ -24,15 +24,15 @@ This is achieved using the `redaction` processor you added earlier, where we def
 
 ### Test the Redaction Processor
 
-Delete the `*.out` files and clear the screen. Restart your `gateway` terminal window, and wait until it is ready to receive data.
+Delete the `*.out` files and clear the screen. Restart your **Gateway** terminal window, and wait until it is ready to receive data.
 
 {{% notice title="Exercise" style="green" icon="running" %}}
 In this exercise, we will **redact** the `user.visa` & `user.mastercard` **values** in the span data before it is exported by the **Agent**.
 
 - **Enable the `redaction/redact` processor** in the `traces` pipeline by removing the `#` in front of it and then restart the **Agent**.
 - **Start the **Agent** Collector** from the **Agent** terminal window.
 - **Send a span containing `Sensitive data`** by running the **cURL** command to send `trace.json`.
-- **Check the debug output** of both the **Agent** and `Gateway` to confirm the values for `user.visa` & `user.mastercard` have been updated. Notice `user.amex` attribute value was NOT redacted because a matching regex pattern was not added to `blocked_values`
+- **Check the debug output** of both the **Agent** and **Gateway** to confirm the values for `user.visa` & `user.mastercard` have been updated. Notice `user.amex` attribute value was NOT redacted because a matching regex pattern was not added to `blocked_values`
 
 {{% tabs %}}
 {{% tab title="New Debug Output" %}}
@@ -178,4 +178,4 @@ Add the Amex card regex to `blocked_values` and restart **Agent** collector.
 
 These are just a few examples of how `attributes` and `redaction` processors can be configured to protect sensitive data. 
 
-Stop the **Agent** and `gateway` using Command-c/Ctrl-c.
+Stop the **Agent** and **Gateway** using Ctrl-C.
diff --git a/content/en/ninja-workshops/10-advanced-otel/7-transform-data/7-1-test-transform.md b/content/en/ninja-workshops/10-advanced-otel/7-transform-data/7-1-test-transform.md
@@ -20,7 +20,7 @@ The script will begin writing lines to a file named `./quotes.log`, while displa
  ```
 
 **Run the Gateway**:
-Find your `Gateway` terminal window, and navigate to the `[WORKSHOP]/7-transform-data` directory and restart the gateway.
+Find your **Gateway** terminal window, and navigate to the `[WORKSHOP]/7-transform-data` directory and restart the gateway.
 
 It should start up normally and state : `Everything is ready. Begin running and processing data.`
 
@@ -32,7 +32,7 @@ It should also start up normally and state : `Everything is ready. Begin running
 {{% notice title="Exercise" style="green" icon="running" %}}
 In this exercise, we will **remove the** `com.splunk/source` and `os.type` **metadata** from the log resource attributes before it is exported by the **Agent**. We will also parse the log body to set the `SeverityText` and `SeverityNumber` on the `LogRecord` and promote the log `body` json fields to log `attributes`.
 
-- **Check the debug output** of both the **Agent** and `Gateway` to confirm that `com.splunk/source` and `os.type` have been removed.
+- **Check the debug output** of both the **Agent** and **Gateway** to confirm that `com.splunk/source` and `os.type` have been removed.
 
 {{% tabs %}}
 {{% tab title="New Debug Output" %}}
@@ -59,7 +59,7 @@ In this exercise, we will **remove the** `com.splunk/source` and `os.type` **met
 {{% /tab %}}
 {{% /tabs %}}
 
-- **Check the debug output** of both the **Agent** and `Gateway` to confirm that `SeverityText` and `SeverityNumber` in the `LogRecord` is now defined with the severity `level` from the log body. Confirm that the JSON fields from the body can be accessed as top-level log `Attributes`.
+- **Check the debug output** of both the **Agent** and **Gateway** to confirm that `SeverityText` and `SeverityNumber` in the `LogRecord` is now defined with the severity `level` from the log body. Confirm that the JSON fields from the body can be accessed as top-level log `Attributes`.
 
 {{% tabs %}}
 {{% tab title="New Debug Output" %}}
@@ -243,4 +243,4 @@ In this exercise, we will **remove the** `com.splunk/source` and `os.type` **met
 
 {{% /notice %}}
 
-Stop the **Agent** and `gateway` using Command-c/Ctrl-c.
+Stop the **Agent** and **Gateway** using Ctrl-C.
diff --git a/content/en/ninja-workshops/10-advanced-otel/8-routing/8-1-routing-test.md b/content/en/ninja-workshops/10-advanced-otel/8-routing/8-1-routing-test.md
diff --git a/content/en/ninja-workshops/10-advanced-otel/8-routing/_index.md b/content/en/ninja-workshops/10-advanced-otel/8-routing/_index.md
