Refresh oct. 2024

* Update links to git submodules
* Remove no-cache for default build method
* Update README.md

Author: gwenblum

.gitmodules

@@ -1,8 +1,8 @@
 [submodule "FlyFast-WebUI"]
 	path = FlyFast-WebUI
 	branch = main
-	url = https://github.com/Aternity/FlyFast-WebUI.git
+	url = https://github.com/riverbed/FlyFast-WebUI.git
 [submodule "FlyFast-FlightSearch"]
 	path = FlyFast-FlightSearch
 	branch = main
-	url = https://github.com/Aternity/FlyFast-FlightSearch.git
+	url = https://github.com/riverbed/FlyFast-FlightSearch.git

README.md

@@ -1,102 +1,145 @@
 # FlyFast
 
-This cookbook contains the full source code for FlyFast, utilizing both the  [FlyFast-WebUI](https://github.com/Aternity/FlyFast-WebUI) and [FlyFast-FlightSearch](https://github.com/Aternity/FlyFast-FlightSearch) to demonstrates how the [ALLUVIO Aternity DEM](https://www.riverbed.com/products/digital-experience-management) solution provides observability of a full-stack application using [OpenTelemetry](https://opentelemetry.io/) auto-instrumentation.
+This cookbook contains the full source code for FlyFast, utilizing both the [FlyFast-WebUI](https://github.com/riverbed/FlyFast-WebUI) and [FlyFast-FlightSearch](https://github.com/riverbed/FlyFast-FlightSearch) to demonstrates how works [OpenTelemetry](https://opentelemetry.io/) with [Riverbed APM](https://www.riverbed.com/products/application-performance-monitoring/).
 
-To instrument the FlyFast demo app, the OpenTelemetry agent will be containerized with the app and injected in the app at startup. The agent will be configured to export the tracing to the ALLUVIO Aternity APM SaaS backend via the [ALLUVIO Aternity OpenTelemetry Collector](https://hub.docker.com/r/aternity/apm-collector) that will run in an another container.
+![diagram](/images/Riverbed-FlyfFast-diagram.png)
 
-![diagram](/images/diagram.png)
+> [!NOTE]
+> The FlyFast demo app is instrumented with OpenTelemetry configured to send the OpenTelemetry traces to the [APM OpenTelemetry Collector](https://hub.docker.com/r/aternity/apm-collector), which in turns exports traces to the Riverbed APM backend (whether APM SaaS or APM Analysis Server).
+> In the app, both the WebUI frontend and the FlighSearch API backend are instrumented: the frontend instrumentation uses an experimental OpenTelemetry for Javascript in the browser, and the FlightSearch API uses OpenTelemetry for Python. 
 
 ## Prerequisites
 
-1. an account for ALLUVIO Aternity APM (SaaS)
-2. optional - an account for ALLUVIO Aternity UJI
+1. an APM SaaS account, or an APM Analysis Server
+2. *optional* an account for Aternity UJI
 3. a Docker host, for example [Docker Desktop](https://www.docker.com/products/docker-desktop)
-4. git installed, see [Git](https://git-scm.com/)
+4. git ([Git](https://git-scm.com/))
 
-## Step by Step
-
-### 1. Get a local copy
+## Step 1. Get a local copy
 
 ```shell
-git clone --recurse-submodules https://github.com/Aternity/FlyFast.git --depth 1
+git clone --recurse-submodules https://github.com/riverbed/FlyFast.git --depth 1
 ```
 
-### 2. Get your CustomerID & SaaS Analysis Server Host details for APM
+## Step 2. Get your information for Riverbed APM
+
+Open the APM web console and navigate to Agents > Install Agents (for example [https://apm.myaccount.aternity.com](https://apm.myaccount.aternity.com))
+
+1. Grab the **Analysis Server Host**, for example *agents.apm.myaccount.aternity.com*
+2. Find your **CustomerID**, for example *12341234-12341234-13241234*
 
-Open ALLUVIO Aternity APM (for example [https://apm.myaccount.aternity.com](https://apm.myaccount.aternity.com)) and navigate to Agents > Install Agents
+Those information are required to activate the [APM OpenTelemetry Collector](https://hub.docker.com/r/aternity/apm-collector) with an APM  account.
+The CustomerID is not required when it is not an APM SaaS.
 
-1. Find your **CustomerID**, for example *12341234-12341234-13241234*
-2. Grab **SaaS Analysis Server Host**, for example *agents.apm.myaccount.aternity.com*
+## Step 3. *optional* Get your information for Aternity UJI
 
-Those information are required to activate the container of the [Aternity APM Collector](https://hub.docker.com/r/aternity/apm-collector)
+<details>
+  <summary>*optional* See details for Aternity UJI</summary>
 
-### 3. Get the UJI Tag Prefix (Optional)
 
-1. Open [ALLUVIO Aternity UJI](https://portals.bluetriangle.com) and navigate to Settings & Administration > Sites
+1. Open [Aternity UJI](https://portals.bluetriangle.com) and navigate to Settings & Administration > Sites
 2. Find the site configured for FlyFast and get the **UJI Tag Prefix**, for example *my-UJI-Tag-Prefix-FlyFast*
 
-### 4. Start the containers
+</details>
+
+## Step 4. Start the containers
+
+Start the containers using the [docker-compose.yaml](docker-compose.yaml), using the snipppet below
+and replacing the values with the information collected at step 2. and step 3.
 
-Start the containers using the [docker-compose.yml](docker-compose.yml), for example with Bash:
+For example in Bash:
 
 ```bash
 cd FlyFast
 
-# Configure the ALLUVIO Aternity APM OpenTelemetry Collector
-# Replace the value with the information collected at step 2.
-export ATERNITY_CUSTOMER_ID="12341234-12341234-13241234"
-export ATERNITY_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
+# Configure the APM OpenTelemetry Collector
+export RIVERBED_APM_SERVER_HOST="agents.apm.myaccount.aternity.com"
+export RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
 
-# Optional - Configure the ALLUVIO Aternity UJI tag
-# Replace "my-UJI-Tag-Prefix-FlyFast" with your UJI Tag Prefix collected at step 3.
-export ALLUVIO_UJI_TAG='<script id=\"ALLUVIO-Aternity-UJI\" src=\"https:\/\/my-UJI-Tag-Prefix-FlyFast\.btttag\.com\/btt\.js\"><\/script>'
+# Start the containers
+docker compose up
+```
 
-# Build the containers
-docker compose build --no-cache
+or in PowerShell:
+
+```PowerShell
+cd FlyFast
+
+# Configure the APM OpenTelemetry Collector
+$env:RIVERBED_APM_SERVER_HOST="agents.apm.myaccount.aternity.com"
+$env:RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
+
+# Start the containers
+docker-compose up
+```
+
+<details>
+  <summary>*optional* Add configuration for Aternity UJI</summary>
+
+in Bash:
+
+```bash
+cd FlyFast
+
+# Configure the APM OpenTelemetry Collector
+export RIVERBED_APM_SERVER_HOST="agents.apm.myaccount.aternity.com"
+export RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
+
+# Optional - Configure the Aternity UJI tag
+# Replace "my-UJI-Tag-Prefix-FlyFast" with your UJI Tag Prefix collected at step 3.
+export ALLUVIO_UJI_TAG='<script id=\"ALLUVIO-Aternity-UJI\" src=\"https:\/\/your-UJI-Tag-Prefix-FlyFast\.btttag\.com\/btt\.js\"><\/script>'
 
 # Start the containers
 docker compose up
 ```
 
-or with PowerShell:
+or in PowerShell
 
 ```PowerShell
 cd FlyFast
 
-# Configure the ALLUVIO Aternity APM OpenTelemetry Collector
+# Configure the APM OpenTelemetry Collector
 # Replace the value with your information collected at step 2.
-$env:ATERNITY_CUSTOMER_ID="12341234-12341234-13241234"
-$env:ATERNITY_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
-
-# Optional - Configure the ALLUVIO Aternity UJI tag
-# Replace "my-UJI-Tag-Prefix-FlyFast" with your UJI Tag Prefix collected at step 3.
-$env:ALLUVIO_UJI_TAG='<script id=\"ALLUVIO-Aternity-UJI\" src=\"https:\/\/my-UJI-Tag-Prefix-FlyFast\.btttag\.com\/btt\.js\"><\/script>'
+$env:RIVERBED_APM_SERVER_HOST="agents.apm.myaccount.aternity.com"
+$env:RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
 
-# Build the containers from scratch
-docker-compose build --no-cache
+# Optional - Configure the Aternity UJI tag
+# Replace "your-UJI-Tag-Prefix-FlyFast" with your UJI Tag Prefix collected at step 3.
+$env:ALLUVIO_UJI_TAG='<script id=\"ALLUVIO-Aternity-UJI\" src=\"https:\/\/your-UJI-Tag-Prefix-FlyFast\.btttag\.com\/btt\.js\"><\/script>'
 
 # Start the containers
 docker-compose up
 ```
 
-### 5. Navigate Through The Application And Monitor
+</details>
+
+## Step 5. Navigate through The Application And Monitor
 
 The web application should now be available on [http://localhost](http://localhost).
 
-Open the url in your browser and navigate through the application a few times to generate some traffic.
+Open the url in your browser and navigate through the application a few times to generate page views and transaction that will be monitored by APM.
 
-### 6. ALLUVIO Aternity APM webconsole
+## Step 6. Open Riverbed APM web console
 
-Go to the APM webconsole to monitor the instance and observe every transaction.
+Go to the APM web console to monitor the instance and observe every transaction.
 
-![ALLUVIO Aternity APM OpenTelemetry Traces](/images/transaction.png)
+![APM OpenTelemetry Traces](/images/transaction.png)
 
 View details of a specific transaction as a waterfall chart:
 
-![ALLUVIO Aternity APM OpenTelemetry Transaction-Detail](/images/transaction-detail.png)
+![APM OpenTelemetry Transaction-Detail](/images/transaction-detail.png)
+
 
 ## Notes
 
+<details>
+  <summary>See Notes</summary>
+
+
+### Add Synthetic Test
+
+In the [Riverbed Community Toolkit](https://github.com/riverbed/Riverbed-Community-Toolkit), the cookbook [Synthetic-004-Browse-FlyFast](https://github.com/riverbed/Riverbed-Community-Toolkit/tree/master/NetIM/Synthetic-Test/Synthetic-004-Browse-FlyFast) show how to set up a synthetic test for FlyFast on a Windows machine.
+
 ### Stop The App and All The Containers
 
 Press `CTRL + C` in the shell where it is running.
@@ -107,6 +150,12 @@ Or in a shell, go to the folder where you keep the [docker-compose.yml](docker-c
 docker-compose stop
 ```
 
+### Rebuild
+
+```shell
+docker compose build --no-cache
+```
+
 ### Updating Based On Future Changes
 
 Stay up to date with the latest changes.
@@ -118,13 +167,15 @@ git submodule update --remote
 ### Clone FlyFast and update submodules
 
 ```shell
-git clone https://github.com/Aternity/FlyFast.git
+git clone https://github.com/riverbed/FlyFast.git
 cd FlyFast
 git submodule init
 git submodule update
 ```
 
+</details>
+
 ## License
-Copyright (c) 2022 Riverbed Technology, Inc.
+Copyright (c) 2022 - 2024 Riverbed Technology, Inc.
 
 The contents provided here are licensed under the terms and conditions of the MIT License accompanying the software ("License"). The scripts are distributed "AS IS" as set forth in the License. The script also include certain third party code. All such third party code is also distributed "AS IS" and is licensed by the respective copyright holders under the applicable terms and conditions (including, without limitation, warranty and liability disclaimers) identified in the license notices accompanying the software.

docker-compose.yml docker-compose.yamldocker-compose.yml renamed to docker-compose.yaml

@@ -1,10 +1,13 @@
+# docker-compose.yaml
+# version: 24.10.6
+#
 # Usage
 #
 # Example in Bash
 #
 #   # Configuration for APM
-#   export ATERNITY_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
-#   export ATERNITY_CUSTOMER_ID="12341234-12341234-13241234"
+#   export RIVERBED_APM_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
+#   export RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
 #
 #   # Optional configuration for UJI
 #   export ALLUVIO_UJI_TAG="<script id=ALLUVIO-Aternity-UJI src=http:\/\/my-UJI-tag-prefix-flyfast\.btttag\.com\/btt\.js><\/script>"
@@ -15,30 +18,29 @@
 # Example in PowerShell
 #
 #   # Configuration for APM
-#   $env:ATERNITY_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
-#   $env:ATERNITY_CUSTOMER_ID="12341234-12341234-13241234"
+#   $env:RIVERBED_APM_SAAS_SERVER_HOST="agents.apm.myaccount.aternity.com"
+#   $env:RIVERBED_APM_CUSTOMER_ID="12341234-12341234-13241234"
 #
 #   # Optional configuration for UJI
 #   $env:ALLUVIO_UJI_TAG="<script id=ALLUVIO-Aternity-UJI src=http:\/\/my-UJI-tag-prefix-flyfast\.btttag\.com\/btt\.js><\/script>"
 #
 #   # Start containers
 #   docker compose up
 
-version: '3.4'
 services:
 
   apm-collector:
     image: registry.hub.docker.com/aternity/apm-collector:latest
     container_name: apm-collector
     environment:
-      SERVER_URL: "wss://${ATERNITY_SAAS_SERVER_HOST}/?RPM_AGENT_CUSTOMER_ID=${ATERNITY_CUSTOMER_ID}"
+      SERVER_URL: "wss://${RIVERBED_APM_SERVER_HOST}/?RPM_AGENT_CUSTOMER_ID=${RIVERBED_APM_CUSTOMER_ID}"
     ports:
       # Uncomment the telemetry protocol used by the application
 
       # OpenTelemetry, https://opentelemetry.io
+      # - "4317:4317/tcp"   # OpenTelemetry OTLP over gRPC
       # - "4318:4318/tcp"     # OpenTelemetry OTLP JSON/Protobuf over HTTP
       - "55681:55681/tcp" # OpenTelemetry OTLP JSON/Protobuf over HTTP
-      # - "4317:4317/tcp"   # OpenTelemetry OTLP over gRPC
 
       # Jaeger, https://www.jaegertracing.io
       # - "14268:14268/tcp" # Jaeger Thrift Binary over HTTP