Refactor OpenTelemetry Ingest Dockerfile and configuration; update en…

…vironment variables and docker-compose for new service integration
yonasBSD · Nov 21, 2024 · 3a1f5c7 · 3a1f5c7
1 parent eec5134
commit 3a1f5c7
Show file tree

Hide file tree

Showing 26 changed files with 497 additions and 30 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -255,6 +255,21 @@ jobs:
       - name: build docker image
         run: sudo docker build -f ./Ingestor/Dockerfile .
 
+  docker-build-open-telemetry-ingest:
+    runs-on: ubuntu-latest
+    env:
+      CI_PIPELINE_ID: ${{github.run_number}}
+    steps:
+      - name: Checkout 
+        uses: actions/checkout@v2
+
+      - name: Preinstall 
+        run: npm run prerun
+
+      # build image probe api
+      - name: build docker image
+        run: sudo docker build -f ./OpenTelemetryIngest/Dockerfile .
+
   docker-build-incoming-request-ingest:
     runs-on: ubuntu-latest
     env:

diff --git a/.github/workflows/compile.yml b/.github/workflows/compile.yml
@@ -216,6 +216,19 @@ jobs:
       - run: cd Common && npm install
       - run: cd Ingestor && npm install && npm run compile && npm run dep-check
 
+  compile-open-telemetry-ingest:
+    runs-on: ubuntu-latest
+    env:
+      CI_PIPELINE_ID: ${{github.run_number}}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.3.0
+      - run: cd Common && npm install
+      - run: cd OpenTelemetryIngest && npm install && npm run compile && npm run dep-check
+
+
   compile-incoming-request-ingest: 
     runs-on: ubuntu-latest
     env:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -613,6 +613,66 @@ jobs:
             GIT_SHA=${{ github.sha }}
             APP_VERSION=7.0.${{needs.generate-build-number.outputs.build_number}}
 
+  open-telemetry-ingest-docker-image-deploy:
+    needs: [generate-build-number]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Docker Meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            oneuptime/open-telemetry-ingest
+            ghcr.io/oneuptime/open-telemetry-ingest
+          tags: |
+            type=raw,value=release,enable=true
+            type=semver,value=7.0.${{needs.generate-build-number.outputs.build_number}},pattern={{version}},enable=true
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.3.0
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Generate Dockerfile from Dockerfile.tpl
+        run: npm run prerun
+
+      # Build and deploy open-telemetry-ingest.
+
+      - name: Login to Docker Hub 
+        uses: docker/[email protected]
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/[email protected]
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          file: ./OpenTelemetryIngest/Dockerfile
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_SHA=${{ github.sha }}
+            APP_VERSION=7.0.${{needs.generate-build-number.outputs.build_number}}
+
 
   incoming-request-ingest-docker-image-deploy:
     needs: [generate-build-number]
@@ -1530,7 +1590,7 @@ jobs:
 
   test-e2e-release-saas: 
     runs-on: ubuntu-latest
-    needs: [copilot-docker-image-deploy, fluent-ingest-docker-image-deploy, docs-docker-image-deploy, api-reference-docker-image-deploy, workflow-docker-image-deploy,  llm-docker-image-deploy, accounts-docker-image-deploy, admin-dashboard-docker-image-deploy, app-docker-image-deploy, dashboard-docker-image-deploy, haraka-docker-image-deploy, ingestor-docker-image-deploy, isolated-vm-docker-image-deploy, home-docker-image-deploy, worker-docker-image-deploy,  otel-collector-docker-image-deploy, probe-docker-image-deploy, status-page-docker-image-deploy, test-docker-image-deploy, test-server-docker-image-deploy, publish-npm-packages, e2e-docker-image-deploy, helm-chart-deploy, generate-build-number, nginx-docker-image-deploy, incoming-request-ingest-docker-image-deploy]
+    needs: [open-telemetry-ingest-docker-image-deploy, copilot-docker-image-deploy, fluent-ingest-docker-image-deploy, docs-docker-image-deploy, api-reference-docker-image-deploy, workflow-docker-image-deploy,  llm-docker-image-deploy, accounts-docker-image-deploy, admin-dashboard-docker-image-deploy, app-docker-image-deploy, dashboard-docker-image-deploy, haraka-docker-image-deploy, ingestor-docker-image-deploy, isolated-vm-docker-image-deploy, home-docker-image-deploy, worker-docker-image-deploy,  otel-collector-docker-image-deploy, probe-docker-image-deploy, status-page-docker-image-deploy, test-docker-image-deploy, test-server-docker-image-deploy, publish-npm-packages, e2e-docker-image-deploy, helm-chart-deploy, generate-build-number, nginx-docker-image-deploy, incoming-request-ingest-docker-image-deploy]
     env:
       CI_PIPELINE_ID: ${{github.run_number}}
     steps:
@@ -1583,7 +1643,7 @@ jobs:
   test-e2e-release-self-hosted: 
     runs-on: ubuntu-latest
     # After all the jobs runs
-    needs: [copilot-docker-image-deploy, incoming-request-ingest-docker-image-deploy, fluent-ingest-docker-image-deploy, docs-docker-image-deploy,  api-reference-docker-image-deploy, workflow-docker-image-deploy, llm-docker-image-deploy, accounts-docker-image-deploy, admin-dashboard-docker-image-deploy, app-docker-image-deploy, dashboard-docker-image-deploy, haraka-docker-image-deploy, ingestor-docker-image-deploy, isolated-vm-docker-image-deploy, home-docker-image-deploy, worker-docker-image-deploy, otel-collector-docker-image-deploy, probe-docker-image-deploy, status-page-docker-image-deploy, test-docker-image-deploy, test-server-docker-image-deploy, publish-npm-packages, e2e-docker-image-deploy, helm-chart-deploy, generate-build-number, nginx-docker-image-deploy]
+    needs: [open-telemetry-ingest-docker-image-deploy, copilot-docker-image-deploy, incoming-request-ingest-docker-image-deploy, fluent-ingest-docker-image-deploy, docs-docker-image-deploy,  api-reference-docker-image-deploy, workflow-docker-image-deploy, llm-docker-image-deploy, accounts-docker-image-deploy, admin-dashboard-docker-image-deploy, app-docker-image-deploy, dashboard-docker-image-deploy, haraka-docker-image-deploy, ingestor-docker-image-deploy, isolated-vm-docker-image-deploy, home-docker-image-deploy, worker-docker-image-deploy, otel-collector-docker-image-deploy, probe-docker-image-deploy, status-page-docker-image-deploy, test-docker-image-deploy, test-server-docker-image-deploy, publish-npm-packages, e2e-docker-image-deploy, helm-chart-deploy, generate-build-number, nginx-docker-image-deploy]
     env:
       CI_PIPELINE_ID: ${{github.run_number}}
     steps:

diff --git a/.github/workflows/test-release.yaml b/.github/workflows/test-release.yaml
@@ -721,6 +721,128 @@ jobs:
             GIT_SHA=${{ github.sha }}
             APP_VERSION=7.0.${{needs.generate-build-number.outputs.build_number}}
 
+  ingestor-docker-image-deploy:
+    needs: generate-build-number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Docker Meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            oneuptime/ingestor
+            ghcr.io/oneuptime/ingestor
+          tags: |
+            type=raw,value=test,enable=true
+            type=semver,value=7.0.${{needs.generate-build-number.outputs.build_number}}-test,pattern={{version}},enable=true
+            
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.3.0
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Generate Dockerfile from Dockerfile.tpl
+        run: npm run prerun
+
+      # Build and deploy ingestor.
+
+      - name: Login to Docker Hub 
+        uses: docker/[email protected]
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/[email protected]
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          file: ./Ingestor/Dockerfile
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_SHA=${{ github.sha }}
+            APP_VERSION=7.0.${{needs.generate-build-number.outputs.build_number}}
+
+  open-telemetry-ingest-docker-image-deploy:
+    needs: generate-build-number
+    runs-on: ubuntu-latest
+    steps:
+      - name: Docker Meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            oneuptime/open-telemetry-ingest
+            ghcr.io/oneuptime/open-telemetry-ingest
+          tags: |
+            type=raw,value=test,enable=true
+            type=semver,value=7.0.${{needs.generate-build-number.outputs.build_number}}-test,pattern={{version}},enable=true
+            
+
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.3.0
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Generate Dockerfile from Dockerfile.tpl
+        run: npm run prerun
+
+      # Build and deploy incoming-request-ingest.
+
+      - name: Login to Docker Hub 
+        uses: docker/[email protected]
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/[email protected]
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          file: ./OpenTelemetryIngest/Dockerfile
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_SHA=${{ github.sha }}
+            APP_VERSION=7.0.${{needs.generate-build-number.outputs.build_number}}
+
   fluent-ingest-docker-image-deploy:
     needs: generate-build-number
     runs-on: ubuntu-latest

diff --git a/.github/workflows/test.open-telemetry-ingest.yaml b/.github/workflows/test.open-telemetry-ingest.yaml
@@ -0,0 +1,21 @@
+name: OpenTelemetryIngest Test
+
+on:
+  pull_request: 
+  push:
+    branches-ignore:
+      - 'hotfix-*'   # excludes hotfix branches
+      - 'release'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      CI_PIPELINE_ID: ${{github.run_number}}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.3.0
+      - run: cd OpenTelemetryIngest && npm install && npm run test
+
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -189,11 +189,25 @@
             "restart": true,
             "autoAttachChildProcesses": true
         },
+        {
+            "address": "127.0.0.1",
+            "localRoot": "${workspaceFolder}/OpenTelemetryIngest",
+            "name": "OpenTelemetryIngest: Debug with Docker",
+            "port": 9937,
+            "remoteRoot": "/usr/src/app",
+            "request": "attach",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node",
+            "restart": true,
+            "autoAttachChildProcesses": true
+        },
         {
             "address": "127.0.0.1",
             "localRoot": "${workspaceFolder}/FluentIngest",
             "name": "Fluent Ingest: Debug with Docker",
-            "port": 9937,
+            "port": 9938,
             "remoteRoot": "/usr/src/app",
             "request": "attach",
             "skipFiles": [

diff --git a/Common/Server/EnvironmentConfig.ts b/Common/Server/EnvironmentConfig.ts
@@ -94,6 +94,12 @@ export const IngestorHostname: Hostname = Hostname.fromString(
   }`,
 );
 
+export const OpenTelemetryIngestHostname: Hostname = Hostname.fromString(
+  `${process.env["SERVER_OPEN_TELEMETRY_INGEST_HOSTNAME"] || "localhost"}:${
+    process.env["OPEN_TELEMETRY_INGEST_PORT"] || 80
+  }`,
+);
+
 export const IncomingRequestIngestHostname: Hostname = Hostname.fromString(
   `${process.env["SERVER_INCOMING_REQUEST_INGEST_HOSTNAME"] || "localhost"}:${
     process.env["INCOMING_REQUEST_INGEST_PORT"] || 80

diff --git a/...metryIngest/Middleware/TelemetryIngest.ts → Common/Server/Middleware/TelemetryIngest.ts b/...metryIngest/Middleware/TelemetryIngest.ts → Common/Server/Middleware/TelemetryIngest.ts
@@ -1,13 +1,13 @@
-import BadRequestException from "Common/Types/Exception/BadRequestException";
-import ProductType from "Common/Types/MeteredPlan/ProductType";
-import ObjectID from "Common/Types/ObjectID";
+import BadRequestException from "../../Types/Exception/BadRequestException";
+import ProductType from "../../Types/MeteredPlan/ProductType";
+import ObjectID from "../../Types/ObjectID";
 import {
   ExpressRequest,
   ExpressResponse,
   NextFunction,
-} from "Common/Server/Utils/Express";
-import TelemetryIngestionKeyService from "Common/Server/Services/TelemetryIngestionKeyService";
-import TelemetryIngestionKey from "Common/Models/DatabaseModels/TelemetryIngestionKey";
+} from "../../Server/Utils/Express";
+import TelemetryIngestionKeyService from "../../Server/Services/TelemetryIngestionKeyService";
+import TelemetryIngestionKey from "../../Models/DatabaseModels/TelemetryIngestionKey";
 
 export interface TelemetryRequest extends ExpressRequest {
   projectId: ObjectID; // Project ID

diff --git a/OpenTelemetryIngest/Service/OTelIngest.ts → ...er/Services/OpenTelemetryIngestService.ts b/OpenTelemetryIngest/Service/OTelIngest.ts → ...er/Services/OpenTelemetryIngestService.ts
diff --git a/Common/ServiceRoute.ts b/Common/ServiceRoute.ts
@@ -28,6 +28,10 @@ export const AdminDashboardRoute: Route = new Route("/admin");
 
 export const IngestorRoute: Route = new Route("/ingestor");
 
+export const OpenTelemetryIngestRoute: Route = new Route(
+  "/open-telemetry-ingest",
+);
+
 export const IncomingRequestIngestRoute: Route = new Route(
   "/incoming-request-ingest",
 );

diff --git a/Common/UI/Config.ts b/Common/UI/Config.ts
@@ -17,6 +17,7 @@ import {
   WorkflowRoute,
   FluentIngestRoute,
   IncomingRequestIngestRoute,
+  OpenTelemetryIngestRoute,
 } from "Common/ServiceRoute";
 import Hostname from "Common/Types/API/Hostname";
 import Protocol from "Common/Types/API/Protocol";
@@ -69,6 +70,9 @@ export const WORKFLOW_HOSTNAME: Hostname = Hostname.fromString(HOST);
 
 export const INGESTOR_HOSTNAME: Hostname = Hostname.fromString(HOST);
 
+export const OPEN_TELEMETRY_INGEST_HOSTNAME: Hostname =
+  Hostname.fromString(HOST);
+
 export const INCOMING_REQUEST_INGEST_HOSTNAME: Hostname =
   Hostname.fromString(HOST);
 
@@ -108,6 +112,12 @@ export const STATUS_PAGE_API_URL: URL = new URL(
   StatusPageApiRoute,
 );
 
+export const OPEN_TELEMETRY_INGEST_URL: URL = new URL(
+  HTTP_PROTOCOL,
+  OPEN_TELEMETRY_INGEST_HOSTNAME,
+  OpenTelemetryIngestRoute,
+);
+
 export const FLUENT_INGEST_URL: URL = new URL(
   HTTP_PROTOCOL,
   FLUENT_INGEST_HOSTNAME,