@zyno-io/devtool-otel 0.0.7

package/README.md

@@ -0,0 +1,9 @@
+Quick launch tool to launch a local Grafana LGTM environment for use in local development.
+
+Startup: `npx @zyno-io/devtool-otel`\
+Shutdown: `npx @zyno-io/devtool-otel down`
+
+Exposes:
+- Grafana at http://localhost:3200/explore
+- gRPC OpenTelemetry collector at http://localhost:4317
+- HTTP OpenTelemetry collector at http://localhost:4318

package/cli.mjs

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+
+import which from "which";
+import { execSync } from "child_process";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+// exposed as import.meta.dirname in Node 20+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const oldCompose = await which("docker-compose", { nothrow: true });
+const composeCmd = oldCompose ? "docker-compose" : "docker compose";
+
+const cmd = process.argv[2] ?? "up";
+
+if (cmd === "up") {
+  await up();
+} else if (cmd === "down") {
+  await down();
+} else {
+  console.error(`Unknown command: ${cmd}`);
+  process.exit(1);
+}
+
+async function up() {
+  await execSync(`${composeCmd} up -d`, {
+    cwd: __dirname + "/resources",
+    stdio: "inherit",
+  });
+
+  console.log(
+    `\nOpenTelemetry setup:\nexport OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318\n\nLoki push API:\nhttp://localhost:3100\n\nYou can now access Grafana at:\nhttp://localhost:3200/explore\n`
+  );
+}
+
+async function down() {
+  await execSync(`${composeCmd} down`, {
+    cwd: __dirname + "/resources",
+    stdio: "inherit",
+  });
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@zyno-io/devtool-otel",
+  "version": "0.0.7",
+  "description": "One-liner to start/stop local OpenTelemetry tools for development",
+  "main": "cli.mjs",
+  "bin": "./cli.mjs",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": {
+      "name": "Signal24 LLC dba Zyno Consulting",
+      "email": "support@zyno.io",
+      "url": "https://zyno.io"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "which": "^6.0.1"
+  }
+}

package/resources/config.alloy

@@ -0,0 +1,72 @@
+// OTLP Receivers
+otelcol.receiver.otlp "receiver" {
+  debug_metrics {
+    disable_high_cardinality_metrics = true
+  }
+
+  grpc {
+    endpoint = "0.0.0.0:4317"
+  }
+
+  http {
+    endpoint = "0.0.0.0:4318"
+    cors {
+      allowed_origins = ["*"]
+      allowed_headers = ["*"]
+    }
+  }
+
+  output {
+    metrics = [otelcol.exporter.prometheus.metrics_converter.input]
+    traces = [otelcol.exporter.otlp.traces_service.input]
+    logs = [otelcol.exporter.loki.logs_service.input]
+  }
+}
+
+otelcol.exporter.prometheus "metrics_converter" {
+  forward_to = [prometheus.remote_write.metrics_service.receiver]
+}
+
+// Metrics Service
+prometheus.remote_write "metrics_service" {
+  endpoint {
+    url = "http://mimir:9009/api/v1/push"
+    send_native_histograms = false
+  }
+
+  wal {
+    truncate_frequency = "2h"
+    min_keepalive_time = "5m"
+    max_keepalive_time = "8h"
+  }
+
+  external_labels = {
+  }
+}
+
+// Tempo
+otelcol.exporter.otlp "traces_service" {
+  client {
+    endpoint = "tempo:4317"
+
+    tls {
+      insecure = true
+    }
+  }
+}
+
+// Loki
+otelcol.exporter.loki "logs_service" {
+  forward_to = [loki.write.logs_service.receiver]
+}
+
+loki.write "logs_service" {
+  endpoint {
+    url = "http://loki:3100/loki/api/v1/push"
+  }
+}
+
+logging {
+  level  = "info"
+  format = "logfmt"
+}

package/resources/docker-compose.yaml

@@ -0,0 +1,43 @@
+services:
+  tempo:
+    image: grafana/tempo:latest
+    command: ["-config.file=/etc/tempo.yaml"]
+    volumes:
+      - ./tempo.yaml:/etc/tempo.yaml
+    ports:
+      - "4320:4318"
+
+  mimir:
+    image: grafana/mimir:latest
+    command: ["-config.file=/etc/mimir.yaml"]
+    volumes:
+      - ./mimir.yaml:/etc/mimir.yaml
+
+  loki:
+    image: grafana/loki:latest
+    command: ["-config.file=/etc/loki.yaml"]
+    volumes:
+      - ./loki.yaml:/etc/loki.yaml
+    ports:
+      - "4319:3100"
+
+  alloy:
+    image: grafana/alloy:latest
+    command: ["run", "/etc/alloy/config.alloy"]
+    volumes:
+      - ./config.alloy:/etc/alloy/config.alloy
+    ports:
+      - "4317:4317"
+      - "4318:4318"
+
+  grafana:
+    image: grafana/grafana:12.3.1
+    volumes:
+      - ./grafana-datasources.yaml:/etc/grafana/provisioning/datasources/datasources.yaml
+    environment:
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+      - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
+      - GF_AUTH_DISABLE_LOGIN_FORM=true
+      - GF_FEATURE_TOGGLES_ENABLE=traceqlEditor traceQLStreaming
+    ports:
+      - "4316:3000"

package/resources/grafana-datasources.yaml

@@ -0,0 +1,35 @@
+apiVersion: 1
+
+datasources:
+  - name: Tempo
+    type: tempo
+    access: proxy
+    orgId: 1
+    url: http://tempo:3200
+    basicAuth: false
+    isDefault: true
+    version: 1
+    editable: false
+    apiVersion: 1
+    uid: tempo
+    jsonData:
+      httpMethod: GET
+      serviceMap:
+        datasourceUid: prometheus
+
+  - name: Loki
+    type: loki
+    access: proxy
+    orgId: 1
+    url: http://loki:3100
+    version: 1
+    editable: false
+    uid: loki
+
+  - name: Mimir
+    type: prometheus
+    access: proxy
+    orgId: 1
+    url: http://mimir:9009/prometheus
+    version: 1
+    editable: true

package/resources/loki.yaml

@@ -0,0 +1,30 @@
+auth_enabled: false
+
+server:
+  http_listen_port: 3100
+  log_level: error
+
+common:
+  ring:
+    instance_addr: 127.0.0.1
+    kvstore:
+      store: inmemory
+  replication_factor: 1
+  path_prefix: /tmp/loki
+
+schema_config:
+  configs:
+    - from: "2024-01-01"
+      store: tsdb
+      object_store: filesystem
+      schema: v13
+      index:
+        prefix: index_
+        period: 24h
+
+storage_config:
+  filesystem:
+    directory: /tmp/loki/chunks
+
+limits_config:
+  allow_structured_metadata: true

package/resources/mimir.yaml

@@ -0,0 +1,42 @@
+multitenancy_enabled: false
+
+blocks_storage:
+  backend: filesystem
+  bucket_store:
+    sync_dir: /tmp/mimir/tsdb-sync
+  filesystem:
+    dir: /tmp/mimir/data/tsdb
+  tsdb:
+    dir: /tmp/mimir/tsdb
+
+compactor:
+  data_dir: /tmp/mimir/compactor
+  sharding_ring:
+    kvstore:
+      store: memberlist
+
+distributor:
+  ring:
+    instance_addr: 127.0.0.1
+    kvstore:
+      store: memberlist
+
+ingester:
+  ring:
+    instance_addr: 127.0.0.1
+    kvstore:
+      store: memberlist
+    replication_factor: 1
+
+ruler_storage:
+  backend: filesystem
+  filesystem:
+    dir: /tmp/mimir/rules
+
+server:
+  http_listen_port: 9009
+  log_level: error
+
+store_gateway:
+  sharding_ring:
+    replication_factor: 1

package/resources/tempo.yaml

@@ -0,0 +1,38 @@
+stream_over_http_enabled: true
+
+server:
+  http_listen_port: 3200
+  log_level: info
+
+query_frontend:
+  search:
+    duration_slo: 5s
+    throughput_bytes_slo: 1.073741824e+09
+  trace_by_id:
+    duration_slo: 5s
+
+distributor:
+  receivers:
+    otlp:
+      protocols:
+        grpc:
+          endpoint: "0.0.0.0:4317"
+        http:
+          endpoint: "0.0.0.0:4318"
+
+ingester:
+  flush_check_period: 5s
+  trace_idle_period: 5s
+  max_block_duration: 30s
+
+compactor:
+  compaction:
+    block_retention: 24h
+
+storage:
+  trace:
+    backend: local
+    wal:
+      path: /tmp/tempo/wal
+    local:
+      path: /tmp/tempo/blocks