Add example compose files

Author: mariuswilms

Dockerfile

@@ -10,7 +10,7 @@ COPY internal ./internal
 
 RUN CGO_ENABLED=0 GOOS=linux go build -o /app
 
-FROM alpine:3.20 as runner
+FROM alpine:3.20 AS runner
 
 COPY --from=builder /app /app
 

examples/.env.example.factorial

@@ -0,0 +1,44 @@
+# Sets up a distributed Tobey instance that uses Redis for coordination.
+#
+# Use the following command to start up two tobey instances:
+#   docker compose up
+#
+# Then hit the loadbalancer:
+#   curl http://localhost:8080/ -X POST -d 'https://example.com'
+#
+# Now:
+# You should see a response from one of the tobey instances. If a crawl
+# request is made, than both instance will process the request.
+services:
+  loadbalancer:
+    image: nginx:latest
+    ports:
+      - "8080:80"
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+
+  tobey-1:
+    build:
+      context: ../../
+    environment:
+      - TOBEY_REDIS_URL=redis://redis:6379
+      - TOBEY_RESULT_REPORTER_DSN=disk:///tmp/tobey
+    volumes:
+      - tobey-cache:/cache
+
+  tobey-2:
+    build:
+      context: ../../
+    environment:
+      - TOBEY_REDIS_URL=redis://redis:6379
+      - TOBEY_RESULT_REPORTER_DSN=disk:///tmp/tobey
+    volumes:
+      - tobey-cache:/cache
+
+  redis:
+    image: redis:latest
+    ports:
+      - "6379:6379"
+
+volumes:
+  tobey-cache:

examples/distributed/compose.yml

@@ -0,0 +1,14 @@
+upstream backend {
+    server tobey-1:8080;
+    server tobey-2:8080;
+}
+
+server {
+    listen 80;
+
+    include /etc/nginx/mime.types;
+
+    location / {
+        proxy_pass http://backend;
+    }
+}

examples/distributed/nginx.conf

@@ -0,0 +1,73 @@
+# Sets up a tobey instance, similar to how we use it at Factorial.
+#
+# Use the following command:
+#   docker compose up
+#
+# Then hit the tobey instance:
+#   curl http://localhost:8080/ -X POST --header "Content-Type: application/json" -d '{
+#     "url": "https://example.org",
+#     "result_reporter_dsn": "webhook://webhook-catcher:8081/incoming"
+#   }' 
+#
+# Now:
+# - Access the Jaeger UI at http://localhost:16686/
+# - Access the Progress UI at http://localhost:9090/
+# - Access the Webhook Catcher UI at http://localhost:8081/
+
+services:
+  tobey:
+    ports:
+      - "8080:8080"
+    build:
+      context: ../../
+    environment:
+      - TOBEY_RESULT_REPORTER_DSN=disk:///tmp/tobey
+      - TOBEY_DYNAMIC_CONFIG=true 
+      - TOBEY_USER_AGENT="WebsiteStandardsBot/1.0"
+      - TOBEY_TELEMETRY="traces"
+      - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://jaeger:4318/v1/traces
+      # - TOBEY_PROGRESS_DSN=factorial://progress:8080
+    volumes:
+      - tobey-cache:/cache
+  
+  # progress:
+  #   image: wsd/progress:latest
+  #   environment:
+  #     - PROGRESS_DATABASE_URL=mysql://db:db@mysql:3306/progress
+  #     - OTEL_SERVICE_NAME=progress
+  #     - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://jaeger:4318/v1/traces
+  #   ports:
+  #     - "9090:8080"
+
+  mysql:
+    image: mariadb
+    environment:
+      - MYSQL_USER=db
+      - MYSQL_PASSWORD=db
+      - MYSQL_ROOT_PASSWORD=root
+    ports:
+      - '3306:3306'
+    expose:
+      - '3306'
+    volumes:
+      - ./mysql/init:/docker-entrypoint-initdb.d
+      - mysql-data:/var/lib/mysql
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    ports:
+      - "16686:16686"
+      - "4318:4318"
+
+  webhook-catcher:
+    image: tarampampam/webhook-tester:latest
+    ports:
+      - "8081:8080"
+    environment:
+      - STORAGE_DRIVER=memory
+      - LOG_LEVEL=debug
+
+
+
+volumes:
+  tobey-cache:
+  mysql-data:

examples/factorial/compose.yml

@@ -1,32 +1,30 @@
 # A docker compose file that sets up a Tobey instance that is instrumented and
 # exposes metrics to Prometheus via /metrics endpoint. The metrics are then
 # scraped by prometheus. Grafana is used to visualize the metrics scraped by
-# Prometheus. It also configures Redis for coordination.
+# Prometheus.
+#
+# Use the following command:
+#   docker compose up
+#
+# Then hit the tobey instance:
+#   curl http://localhost:8080/ -X POST -d 'https://example.com'
+# 
+# Now:
+# - Access the Jaeger UI at http://localhost:16686/
+# - Access the Grafana UI at http://localhost:3000/ (admin/admin)
 
 services:
   tobey:
     ports:
       - "8080:8080"
     build:
-      context: .
+      context: ../../
     environment:
-      - TOBEY_TELEMETRY=metrics
-      - TOBEY_REDIS_URL=redis://redis:6379
-      - TOBEY_RESULTS_URL=disk:///tmp/tobey
+      - TOBEY_TELEMETRY="metrics traces"
+      - OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://jaeger:4318/v1/traces
+      - TOBEY_RESULT_REPORTER_DSN=disk:///tmp/tobey
     volumes:
       - tobey-cache:/cache
-    # Optional healthcheck.
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:8080/healthz"]
-      interval: 30s
-      timeout: 10s
-      retries: 3
-      start_period: 40s
-
-  redis:
-    image: redis:latest
-    ports:
-      - "6379:6379"
 
   prometheus:
     image: prom/prometheus
@@ -44,6 +42,13 @@ services:
     volumes:
       - grafana-data:/var/lib/grafana
 
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    ports:
+      - "16686:16686"
+      - "4318:4318"
+
+
 volumes:
   tobey-cache:
   grafana-data:

examples/compose.yml examples/instrumented/compose.ymlexamples/compose.yml renamed to examples/instrumented/compose.yml

@@ -0,0 +1,34 @@
+# Sets up a tobey instance that is configured to serve requests within 
+# a pipeline.
+#
+# Use the following command:
+#   curl http://localhost:8080/ -X POST --header "Content-Type: application/json" -d '{
+#     "url": "https://example.org",
+#     "result_reporter_dsn": "webhook://webhook-catcher/incoming"
+#   }' 
+#
+# Now:
+# - Access the Webhook Catcher UI at http://localhost:8081/
+
+services:
+  tobey:
+    ports:
+      - "8080:8080"
+    build:
+      context: ../../
+    environment:
+      - TOBEY_DYNAMIC_CONFIG=true 
+      - TOBEY_RESULT_REPORTER_DSN=noop://
+    volumes:
+      - tobey-cache:/cache
+
+  webhook-catcher:
+    image: tarampampam/webhook-tester:latest
+    ports:
+      - "8081:8080"
+    environment:
+      - STORAGE_DRIVER=memory
+      - LOG_LEVEL=debug
+
+volumes:
+  tobey-cache:

examples/pipelined/compose.yml

@@ -0,0 +1,18 @@
+# Use the following command to start up two tobey instances:
+#   docker compose up
+#
+# Then hit the tobey instance:
+#   curl http://localhost:8080/ -X POST -d 'https://example.com'
+services:
+  tobey:
+    ports:
+      - "8080:8080"
+    build:
+      context: ../../
+    environment:
+      - TOBEY_RESULT_REPORTER_DSN=disk:///tmp/tobey
+    volumes:
+      - tobey-cache:/cache
+
+volumes:
+  tobey-cache: