diff --git a/content/en/ninja-workshops/10-advanced-otel/10-agent/1-initialtest.md b/content/en/ninja-workshops/10-advanced-otel/10-agent/1-initialtest.md index 01bb6affd..8ac12c9cb 100644 --- a/content/en/ninja-workshops/10-advanced-otel/10-agent/1-initialtest.md +++ b/content/en/ninja-workshops/10-advanced-otel/10-agent/1-initialtest.md @@ -161,7 +161,7 @@ This file will allow us to test how the OpenTelemetry Collector processes and se {{% /tab %}} -Next, Open a second terminal window and navigate to the `[WORKSHOP]/1-agent` folder. In this new terminal (used for running `Tests`), execute the following command to send a **span** to test your setup: +Next, Open a second terminal window and navigate to the `[WORKSHOP]/1-agent` directory. In this new terminal (used for running `Tests`), execute the following command to send a **span** to test your setup: {{% tabs %}} {{% tab title="cURL Command" %}} diff --git a/content/en/ninja-workshops/10-advanced-otel/40-filelog/1-agent-filelog.md b/content/en/ninja-workshops/10-advanced-otel/40-filelog/1-agent-filelog.md index 11f4f1879..111badcf2 100644 --- a/content/en/ninja-workshops/10-advanced-otel/40-filelog/1-agent-filelog.md +++ b/content/en/ninja-workshops/10-advanced-otel/40-filelog/1-agent-filelog.md @@ -6,7 +6,7 @@ weight: 1 ### Update the agent configuration -Check that you are in the `[WORKSHOP]/3-filelog` folder. Open the `agent.yaml` copied across earlier and in your editor and add the `filelog` receiver to the `agent.yaml`. +Check that you are in the `[WORKSHOP]/3-filelog` directory. Open the `agent.yaml` copied across earlier and in your editor and add the `filelog` receiver to the `agent.yaml`. {{% notice title="Exercise" style="green" icon="running" %}} @@ -41,9 +41,9 @@ Validate the agent configuration using **[otelbin.io](https://www.otelbin.io/)** ## Test the Filelog receiver -Find your `gateway` terminal window, navigate to the `[WORKSHOP]/3-filelog` folder, start the `gateway` collector and wait until it is ready to receive data. +Find your `gateway` terminal window, navigate to the `[WORKSHOP]/3-filelog` directory, start the `gateway` collector and wait until it is ready to receive data. -Next, to test the Filelog Receiver, find your `agent` terminal window, navigate to the `[WORKSHOP]/3-filelog` folder and start the agent. +Next, to test the Filelog Receiver, find your `agent` terminal window, navigate to the `[WORKSHOP]/3-filelog` directory and start the agent. The agent should start to send **CPU** metrics again as before and both the agent and the gateway should reflect that in their debug output like this: diff --git a/content/en/ninja-workshops/10-advanced-otel/50-gateway/1-gateway-test.md b/content/en/ninja-workshops/10-advanced-otel/50-gateway/1-gateway-test.md index 5c9c0c342..c7a13b179 100644 --- a/content/en/ninja-workshops/10-advanced-otel/50-gateway/1-gateway-test.md +++ b/content/en/ninja-workshops/10-advanced-otel/50-gateway/1-gateway-test.md @@ -6,7 +6,7 @@ weight: 1 ## Test Gateway -Open a 3rd terminal window, this one will be used to run the `gateway` and navigate to the`[WORKSHOP]/2-gateway` folder and run the following command to test the gateway configuration: +Open a 3rd 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 @@ -24,7 +24,7 @@ If everything is set up correctly, the first and last lines of the output should ### Update agent configuration -Select your `agent` terminal window, and also navigate to the `[WORKSHOP]/2-gateway` folder. +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` one. (this is now the preferred exporter for Splunk Observability Cloud): {{% notice title="Exercise" style="green" icon="running" %}} diff --git a/content/en/ninja-workshops/10-advanced-otel/50-gateway/2-test-agent-gateway.md b/content/en/ninja-workshops/10-advanced-otel/50-gateway/2-test-agent-gateway.md index 41e9e6c3f..03fe16991 100644 --- a/content/en/ninja-workshops/10-advanced-otel/50-gateway/2-test-agent-gateway.md +++ b/content/en/ninja-workshops/10-advanced-otel/50-gateway/2-test-agent-gateway.md @@ -112,9 +112,9 @@ Open the `gateway-metrics.out` file. It should contain CPU metrics, including de Next, make sure both the gateway and the agent are still running in their respective terminals. -Find your `test` terminal window, and also navigate to the `[WORKSHOP]/2-gateway` folder. +Find your `test` terminal window, and also navigate to the `[WORKSHOP]/2-gateway` directory. -Check that you have copied the `trace.json` to the `2-gateway` folder then run the following `curl` command to send a trace: (Both the `agent` and the `gateway` should show the Debug output from the second tab) +Check that you have copied the `trace.json` to the `2-gateway` directory then run the following `curl` command to send a trace: (Both the `agent` and the `gateway` should show the Debug output from the second tab) {{% tabs %}} {{% tab title="cURL Command" %}} diff --git a/content/en/ninja-workshops/10-advanced-otel/60-resilience/1-test-resilience.md b/content/en/ninja-workshops/10-advanced-otel/60-resilience/1-test-resilience.md index 62ef49f27..e8b9b08ae 100644 --- a/content/en/ninja-workshops/10-advanced-otel/60-resilience/1-test-resilience.md +++ b/content/en/ninja-workshops/10-advanced-otel/60-resilience/1-test-resilience.md @@ -11,17 +11,17 @@ In this section we are going to simulate an outage on the network between the `a {{% notice title="Exercise" style="green" icon="running" %}} **Run the Gateway**: -Find your `Gateway` terminal window, and navigate to the `[WORKSHOP]/4-resilience` folder 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.` **Run the Agent**: -Find your `Agent` terminal window and navigate to the `[WORKSHOP]/4-resilience` folder and restart the agent with the resilience configurations specified in the YAML file. +Find your `Agent` terminal window and navigate to the `[WORKSHOP]/4-resilience` directory and restart the agent with the resilience configurations specified in the YAML file. It should also start up normally and state : `Everything is ready. Begin running and processing data.` **Send a Test Trace**: -Find your `Test` terminal window and navigate to the `[WORKSHOP]/4-resilience` folder. From there, send a test trace to confirm that communication is functioning as expected. +Find your `Test` terminal window and navigate to the `[WORKSHOP]/4-resilience` directory. From there, send a test trace to confirm that communication is functioning as expected. Both the agent and gateway should display debug information, including the trace you just sent. Additionally, the gateway should generate a new `./gateway-traces.out` file. diff --git a/content/en/ninja-workshops/10-advanced-otel/60-resilience/_index.md b/content/en/ninja-workshops/10-advanced-otel/60-resilience/_index.md index 389973f17..cdb9393b9 100644 --- a/content/en/ninja-workshops/10-advanced-otel/60-resilience/_index.md +++ b/content/en/ninja-workshops/10-advanced-otel/60-resilience/_index.md @@ -45,8 +45,8 @@ Our first task is to implement **checkpointing** using the `file_storage` extens ```yaml file_storage/checkpoint: # Extension Type/Name - # Defines the folder where checkpoint files will be stored - directory: "./checkpoint-folder" + # Defines the directory where checkpoint files will be stored + directory: "./checkpoint-dir" # Ensures that the directory is created if not exist create_directory: true # Specifies timeout for file operations for checkpointing @@ -56,7 +56,7 @@ Our first task is to implement **checkpointing** using the `file_storage` extens # Controls if compaction process begins at OpenTelemetry Collector startup on_start: true # Specifies the directory used for compaction (as a midstep) - directory: "./checkpoint-folder/tmp" + directory: "./checkpoint-dir/tmp" # Size limit for checkpoint transactions before compaction occurs max_transaction_size: 65536 ``` diff --git a/content/en/ninja-workshops/10-advanced-otel/70-dropping-spans/_index.md b/content/en/ninja-workshops/10-advanced-otel/70-dropping-spans/_index.md index fa02b4b9b..d543fa195 100644 --- a/content/en/ninja-workshops/10-advanced-otel/70-dropping-spans/_index.md +++ b/content/en/ninja-workshops/10-advanced-otel/70-dropping-spans/_index.md @@ -123,7 +123,7 @@ 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` folder 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. diff --git a/content/en/ninja-workshops/10-advanced-otel/80-sensitive-data/_index.md b/content/en/ninja-workshops/10-advanced-otel/80-sensitive-data/_index.md index e9d0a0cc1..855c50fd7 100644 --- a/content/en/ninja-workshops/10-advanced-otel/80-sensitive-data/_index.md +++ b/content/en/ninja-workshops/10-advanced-otel/80-sensitive-data/_index.md @@ -240,7 +240,7 @@ Validate the agent configuration using **[otelbin.io](https://www.otelbin.io/)** ### Step 2: Verify the Redaction -Ensure that the `agent` is started the `[WORKSHOP]/6-sensitive-data` folder using the correct agent configuration yaml. Next, update and use the **cURL** command we used earlier to send the `health.json` payload, and send the `trace.json` data created above. +Ensure that the `agent` is started the `[WORKSHOP]/6-sensitive-data` directory using the correct agent configuration yaml. Next, update and use the **cURL** command we used earlier to send the `health.json` payload, and send the `trace.json` data created above. After the collector processes the data, verify that: diff --git a/content/en/ninja-workshops/10-advanced-otel/95-routing/8-1-routing-test.md b/content/en/ninja-workshops/10-advanced-otel/95-routing/8-1-routing-test.md index ba1aaf6e2..1229aa35d 100644 --- a/content/en/ninja-workshops/10-advanced-otel/95-routing/8-1-routing-test.md +++ b/content/en/ninja-workshops/10-advanced-otel/95-routing/8-1-routing-test.md @@ -11,11 +11,11 @@ In this section, we will test the `routing` rule configured for the `gateway`. T {{% notice title="Exercise" style="green" icon="running" %}} - **Run the Gateway**: -Find your `Gateway` terminal window, and navigate to the `[WORKSHOP]/8-routing` folder and restart the gateway with the routing configurations specified in the gateway.yaml. +Find your `Gateway` terminal window, and navigate to the `[WORKSHOP]/8-routing` directory and restart the gateway with the routing configurations specified in the gateway.yaml. It should start up normally and state : `Everything is ready. Begin running and processing data.` - **Run the Agent**: -Find your `Agent` terminal window and navigate to the `[WORKSHOP]/8-routing` folder and restart the agent with the regular `agent.yaml`. +Find your `Agent` terminal window and navigate to the `[WORKSHOP]/8-routing` directory and restart the agent with the regular `agent.yaml`. It should also start up normally and state : `Everything is ready. Begin running and processing data.` - **Create a trace for different Environments** diff --git a/content/en/ninja-workshops/10-advanced-otel/95-routing/_index.md b/content/en/ninja-workshops/10-advanced-otel/95-routing/_index.md index 7970b59c1..de34f22e3 100644 --- a/content/en/ninja-workshops/10-advanced-otel/95-routing/_index.md +++ b/content/en/ninja-workshops/10-advanced-otel/95-routing/_index.md @@ -11,7 +11,7 @@ For example, you might want to send *production* data to one exporter while dire ### Setup -In the `[WORKSHOP]` directory create a new subdirectory called `8-routing`, then copy `*.yaml`, `*.json` and your `log-gen` script from the `7-transform-data` folder. +In the `[WORKSHOP]` directory create a new subdirectory called `8-routing`, then copy `*.yaml`, `*.json` and your `log-gen` script from the `7-transform-data` directory. {{% tab title="Initial Directory Structure" %}} diff --git a/content/en/ninja-workshops/10-advanced-otel/master-agent.yaml b/content/en/ninja-workshops/10-advanced-otel/master-agent.yaml index 87649c3c0..6d18df61b 100644 --- a/content/en/ninja-workshops/10-advanced-otel/master-agent.yaml +++ b/content/en/ninja-workshops/10-advanced-otel/master-agent.yaml @@ -2,7 +2,7 @@ extensions: health_check: # Enables the health check extension endpoint: 0.0.0.0:13133 file_storage/psq: # Extension Type/Name - # Defines the folder where checkpoint files will be stored + # Defines the directory where checkpoint files will be stored directory: "./checkpoint-folder" # Ensures that the directory is created if not exist create_directory: true