introduce otelgen tool for OTLP endpoints

yildizfatih · yildizfatih · commit 034a66d6323f · 2025-10-19T20:14:48.000-07:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,31 @@
+# Binaries
+otelgen
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test files
+*.test
+*_test.go
+
+# Git
+.git
+.gitignore
+
+# Documentation
+README.md
+
+# IDE
+.vscode
+.idea
+*.swp
+*.swo
+*~
+
+# CI/CD
+.github
+.gitlab-ci.yml
+
+# Claude
+.claude
diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml
@@ -0,0 +1,57 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - 'v*'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          platforms: linux/amd64,linux/arm64
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,26 @@
+# Binaries
+otelgen
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool
+*.out
+
+# Dependency directories
+vendor/
+
+# Go workspace file
+go.work
+
+# IDE and editor files
+.claude
+.vscode
+.idea
+*.swp
+*.swo
+*~
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,30 @@
+FROM golang:1.21-alpine AS builder
+
+WORKDIR /build
+
+# Copy go mod files
+COPY go.mod go.sum ./
+
+# Download dependencies
+RUN go mod download
+
+# Copy source code
+COPY cmd/ ./cmd/
+COPY pkg/ ./pkg/
+
+# Build static binary
+RUN CGO_ENABLED=0 GOOS=linux go build \
+    -trimpath \
+    -ldflags='-w -s -extldflags "-static"' \
+    -o otelgen ./cmd/otelgen
+
+# Final stage - use scratch for minimal image
+FROM scratch
+
+# Copy CA certificates for TLS
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+
+# Copy the binary
+COPY --from=builder /build/otelgen /otelgen
+
+ENTRYPOINT ["/otelgen"]
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EdgeDelta, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,2 +1,173 @@
-# otelgen
-Simple, reliable CLI tool for generating OpenTelemetry traces, metrics, and logs to test OTLP endpoints
+# Telemetrygen
+
+A simple and reliable CLI tool for generating OpenTelemetry traces, metrics, and logs to test OTLP endpoints.
+
+## Features
+
+- Generate traces, metrics, and logs
+- Support for gRPC, gRPCs, HTTP, and HTTPS protocols
+- Automatic port selection (4317 for gRPC, 4318 for HTTP)
+- Configurable rate and duration
+- Simple and intuitive CLI interface
+
+## Installation
+
+### Build from source
+
+```bash
+go build -o telemetrygen
+```
+
+### Build Docker image
+
+```bash
+docker build -t telemetrygen .
+```
+
+The Docker image uses a multi-stage build with `scratch` as the final base image for minimal size (~20MB).
+
+## Usage
+
+### Traces
+
+Generate trace data:
+
+```bash
+# Using gRPCs (secure gRPC)
+./telemetrygen traces \
+  --otlp-endpoint grpcs://852e95f4-5bbc-4d54-9879-b8591ff6194c-grpc-us-west2-cf.aws-staging.edgedelta.com:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+
+# Using HTTP
+./telemetrygen traces \
+  --otlp-endpoint http://localhost:4318 \
+  --service my-service \
+  --rate 10 \
+  --duration 1m
+
+# Port is optional - will use default 4317 for gRPC
+./telemetrygen traces \
+  --otlp-endpoint grpc://localhost \
+  --service my-service
+```
+
+### Metrics
+
+Generate metrics data:
+
+```bash
+# Using gRPCs
+./telemetrygen metrics \
+  --otlp-endpoint grpcs://852e95f4-5bbc-4d54-9879-b8591ff6194c-grpc-us-west2-cf.aws-staging.edgedelta.com:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+
+# Using HTTPS
+./telemetrygen metrics \
+  --otlp-endpoint https://localhost:4318 \
+  --service my-service \
+  --rate 5 \
+  --duration 30s
+```
+
+### Logs
+
+Generate log data:
+
+```bash
+# Using gRPCs
+./telemetrygen logs \
+  --otlp-endpoint grpcs://852e95f4-5bbc-4d54-9879-b8591ff6194c-grpc-us-west2-cf.aws-staging.edgedelta.com:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+
+# Using HTTP with custom port
+./telemetrygen logs \
+  --otlp-endpoint http://localhost:8080 \
+  --service my-service \
+  --rate 20 \
+  --duration 5s
+```
+
+## Docker Usage
+
+```bash
+# Traces
+docker run --rm telemetrygen traces \
+  --otlp-endpoint grpcs://your-endpoint:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+
+# Metrics
+docker run --rm telemetrygen metrics \
+  --otlp-endpoint grpcs://your-endpoint:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+
+# Logs
+docker run --rm telemetrygen logs \
+  --otlp-endpoint grpcs://your-endpoint:4317 \
+  --service my-service \
+  --rate 1 \
+  --duration 10s
+```
+
+## Flags
+
+| Flag | Description | Default | Required |
+|------|-------------|---------|----------|
+| `--otlp-endpoint` | OTLP endpoint URL (grpc://, grpcs://, http://, https://) | - | Yes |
+| `--service` | Service name for telemetry | telemetrygen | No |
+| `--rate` | Number of telemetry items per second | 1 | No |
+| `--duration` | How long to generate telemetry (e.g., 10s, 1m, 1h) | 10s | No |
+| `--insecure` | Use insecure connection (not implemented yet) | false | No |
+
+## Protocol Support
+
+- `grpc://` - Insecure gRPC (default port: 4317)
+- `grpcs://` - Secure gRPC with TLS (default port: 4317)
+- `http://` - Insecure HTTP (default port: 4318)
+- `https://` - Secure HTTP with TLS (default port: 4318)
+
+## Default Ports
+
+If you don't specify a port in the endpoint URL, the following defaults are used:
+
+- gRPC/gRPCs: 4317
+- HTTP/HTTPS: 4318
+
+## Examples
+
+```bash
+# Quick test with local collector
+./telemetrygen traces --otlp-endpoint grpc://localhost --service test-app --duration 5s
+
+# High-volume test
+./telemetrygen metrics --otlp-endpoint http://localhost:4318 --service load-test --rate 100 --duration 1m
+
+# Production endpoint test
+./telemetrygen logs --otlp-endpoint grpcs://prod.example.com:4317 --service prod-app --rate 10 --duration 30s
+```
+
+## What Gets Generated
+
+### Traces
+- Parent spans with child spans
+- Random operation types and IDs
+- Realistic timing and nesting
+
+### Metrics
+- Counter: `telemetrygen.requests`
+- Histogram: `telemetrygen.duration`
+- Gauge: `telemetrygen.cpu_usage`
+
+### Logs
+- Various log levels (INFO, WARN, ERROR, DEBUG)
+- Realistic log messages
+- Additional attributes (component, request_id, user_id)
diff --git a/go.mod b/go.mod
@@ -0,0 +1,35 @@
+module github.com/edgedelta/otelgen
+
+go 1.21
+
+require (
+	github.com/spf13/cobra v1.8.0
+	go.opentelemetry.io/otel v1.24.0
+	go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.24.0
+	go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp v1.24.0
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.24.0
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.24.0
+	go.opentelemetry.io/otel/metric v1.24.0
+	go.opentelemetry.io/otel/sdk v1.24.0
+	go.opentelemetry.io/otel/sdk/metric v1.24.0
+	go.opentelemetry.io/otel/trace v1.24.0
+	google.golang.org/grpc v1.62.0
+)
+
+require (
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/grpc-ecosystem/grpc-gateway/v2 v2.19.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.24.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.1.0 // indirect
+	golang.org/x/net v0.20.0 // indirect
+	golang.org/x/sys v0.17.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240123012728-ef4313101c80 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240123012728-ef4313101c80 // indirect
+	google.golang.org/protobuf v1.32.0 // indirect
+)
diff --git a/go.sum b/go.sum
