Telegen

Getting Started

  • Getting Started
    • Quick Start Guide
      • Overview
      • Prerequisites
        • System Requirements
        • Kernel Requirements
      • Installation Methods
        • Kubernetes (Recommended)
        • Linux
        • Docker
      • Verify Installation
        • Check Agent Status
        • Check Health Endpoint
        • Check Metrics
      • Targeted Instrumentation (Optional)
      • What Gets Collected
        • Auto-Discovered Metadata
      • Next Steps
    • Core Concepts
      • Deployment Modes
        • Agent Mode
        • Collector Mode
      • Signal Types
        • Signal Correlation
      • Auto-Discovery
        • Cloud Detection
        • Runtime Detection
        • Database Detection
      • eBPF Programs
        • eBPF Program Types Used
      • Resource Attributes
      • Next Steps
    • Architecture Overview
      • High-Level Architecture
        • Component Overview
      • Data Flow
      • eBPF Tracer Architecture
        • Tracer Types
        • eBPF Maps
      • Pipeline Architecture
        • Signal Processing Pipeline
        • Export Pipeline
      • Memory Architecture
        • Buffer Management
        • Memory Limits
      • Security Model
        • Required Capabilities
        • Privilege Separation
      • High Availability
        • DaemonSet Mode
        • Collector Mode (HA)
      • Performance Characteristics
        • Overhead
        • Throughput
      • Next Steps

Installation

  • Installation
    • Deployment Methods
    • Quick Reference
      • Minimum Requirements
      • Choosing a Deployment Mode
        • Pipeline Deployment Guide
        • Kubernetes Installation
        • Helm Installation
        • Docker Installation
        • Linux Installation
        • OpenShift Installation
        • AWS ECS Installation

Configuration

  • Configuration
    • Configuration Philosophy
    • Common Exporter Pipeline
    • Configuration Methods
    • Sections
      • Minimal Configuration
        • Zero-Config Approach
        • Environment Variable Only
        • Minimal Config File Examples
        • What Gets Enabled by Default
        • Targeted Instrumentation
        • Enabling Additional Features
        • Next Steps
      • Pipeline Configuration
        • Overview
        • Data Quality Limits
        • Signal Transformation
        • PII Redaction
        • Export Configuration
        • Operations
        • Environment Variables
        • Complete Example
      • Network Infra Firewalls
        • Supported firewalls
        • Example config
        • Runtime notes
      • Full Configuration Reference
        • Configuration File Locations
        • Core Configuration
        • Common Exporter Pipeline
        • OTLP Export Configuration
        • Agent Configuration
        • Collector Configuration
        • Queue Configuration
        • Retry Configuration
        • Self-Telemetry
        • Cloud Configuration
        • Signal Metadata
        • Next Steps
      • Agent Mode Configuration
        • Overview
        • When to Use Agent Mode
        • Minimal Agent Configuration
        • eBPF Configuration
        • Network Tracing
        • Process Discovery
        • Continuous Profiling
        • Security Monitoring
        • Log Collection
        • GPU Monitoring
        • Resource Limits
        • Kubernetes-Specific
        • Example: Mutual TLS to the Collector
        • Example: Performance-Optimized
        • Next Steps
      • Collector Mode Configuration
        • Overview
        • When to Use Collector Mode
        • Minimal Collector Configuration
        • SNMP Collection
        • SNMP Trap Receiver
        • SNMP Discovery
        • Storage Array Monitoring
        • Network Infrastructure APIs
        • Hybrid Mode
        • Resource Configuration
        • Example: Data Center Infrastructure
        • Next Steps
      • Environment Variables
        • Overview
        • Naming Convention
        • Core Variables
        • OTLP Export Variables
        • Agent Variables
        • Collector Variables
        • Cloud Variables
        • Self-Telemetry Variables
        • Queue Variables
        • Backoff Variables
        • Usage Examples
        • Precedence
        • Secret Substitution
        • Next Steps

Features

  • Features
    • Overview
    • Feature Categories
      • Core Observability
        • Auto-Discovery
        • Distributed Tracing
        • Log Collection & Trace Enrichment
        • Continuous Profiling
        • Kubernetes Metrics & Events Streaming
      • Messaging & RPC
        • Messaging Protocol Tracing
        • SunRPC (ONC RPC) Tracing
      • Security & Network
        • Security Observability
        • Network Observability
      • Infrastructure
        • Database Tracing
        • SNMP Receiver
        • Storage Adapters
      • Language-Specific
        • C/C++ Application Instrumentation
        • Go Channel-Link Events
      • Specialized
        • AI/ML Observability
        • Node Exporter Fusion
        • Unified Pipeline Architecture
    • Feature Matrix
  • Messaging Protocol Tracing
    • Overview
    • AMQP 0-9-1 (RabbitMQ)
      • Detected Operations
      • Destination Resolution
      • Sample Span
    • AMQP 1.0
      • Detected Performatives
      • Messaging System Disambiguation
    • OpenWire (ActiveMQ)
      • Detection
      • Sample Span
    • STOMP
      • Detected Commands
    • Kafka
      • Configuration
    • OpenTelemetry Attributes
    • Architecture
    • eBPF Implementation
      • Generic Tracer (kprobe-based)
      • Go Tracer (uprobe-based)
      • Parsers (userspace)
      • Transform Layer
    • Configuration
    • Metrics
    • Troubleshooting
      • AMQP 1.0 system not resolving correctly
      • STOMP frames not captured
      • RabbitMQ AMQP 0-9-1 ack spans missing destination
  • SunRPC (ONC RPC) Tracing
    • Overview
    • Protocol Details
    • Detected Program IDs
    • Span Details
      • SunRPC Client Span
      • SunRPC Server Span
    • Configuration
    • Integration
    • Limitations
    • Related Features
  • C/C++ Application Instrumentation
    • Overview
    • Supported Drivers
      • PostgreSQL
      • MySQL / MariaDB
      • MSSQL / SQL Server
      • Oracle
    • How It Works
      • Wire Protocol Capture (Generic Tracer)
      • Language Detection (Semconv Refinement)
    • Sample Span (C++ with libpq)
    • Configuration
    • Comparison: C/C++ vs Go vs Java
    • Limitations
    • Troubleshooting
      • C/C++ spans missing process.language=cpp
      • Database queries not captured
  • Go Channel-Link Events
    • Overview
    • How It Works
      • eBPF Uprobe Capture
      • Goexec Offset Resolution
      • Span Link Creation
    • Configuration
    • Span Attributes
      • Channel-Link Span Link
      • Channel Contention Event
    • Requirements
    • Limitations
    • Troubleshooting
      • Channel events not appearing
      • Incorrect span links
    • Related Features
  • Kubernetes Metrics & Events Streaming
    • Overview
    • Kube-State-Metrics Streaming
      • Configuration
      • Metrics Collected
      • Signal Metadata
    • cadvisor Streaming
      • Configuration
      • Metrics Collected
    • Kubernetes Events as OTLP Logs
      • Configuration
      • Sample Event Log
      • Event Types
    • Start-Order Independence
    • Health Endpoints
      • Telemetry Counters
    • Deployment
      • DaemonSet (Agent Mode)
      • RBAC
    • Configuration Reference
  • Unified Pipeline Architecture
    • High-Level Architecture
    • Signal Sources
    • Adapter Registry
    • Converting Pipeline
    • Integration Layer
      • Limits
      • Transforms
      • Signal Metadata
    • Persistent WAL Queues
      • Queue Structure
      • Queue Operations
      • Legacy Remote-Write Path
    • Multi-Endpoint Exporter
      • Export Modes
      • Circuit Breaker
      • Shared OTLP Clients
    • OBI Span Bridge
    • Runtime Sources
    • Multi-Worker Export
    • Configuration
      • Minimal (Zero-Config)
      • Full Pipeline Configuration
    • Migration from Legacy Pipeline

Integrations

  • Integrations
    • Overview
    • Topics
      • OpenTelemetry Collector Integration
        • Overview
        • Basic Setup
        • Deployment Patterns
        • Collector Processing
        • Multi-Tenant Setup
        • Load Balancing
        • High Availability
        • Security
        • Profiles (OTLP Profiles)
        • Example: Complete Production Setup
        • Next Steps
      • Backend Integrations
        • Overview
        • Grafana Cloud
        • Jaeger
        • Prometheus
        • Datadog
        • New Relic
        • Elastic APM
        • Splunk
        • Honeycomb
        • Lightstep (ServiceNow)
        • Azure Monitor
        • AWS X-Ray
        • Google Cloud Trace
        • Tempo (Grafana)
        • Mimir (Grafana Metrics)
        • Loki (Grafana Logs)
        • Pyroscope (Profiles)
        • Multi-Backend Fan-Out
        • Backend Selection Guide
        • Next Steps
    • Supported Backends
    • Quick Links

Guides

  • OBI Lineage and Upstream
    • Upstream dependency
    • Attribution
  • OBI Attribute Parity Check
    • Test coverage
    • Conversion behavior
    • Additions / differences
  • Telegen V3 Migration - Phase 0 Baseline and Legacy Parity Checklist
    • Baseline Evidence
    • Legacy Pipeline Parity Checklist
    • Deletion Gate
  • Telegen V3 Migration - Phase 1.1 Dependency Mapping (Report)
    • Scope and Method
    • Importers -> Vendored Paths -> Upstream Targets
      • 1) github.com/mirastacklabs-ai/telegen/cmd/telegen
      • 2) github.com/mirastacklabs-ai/telegen/internal/config
      • 3) github.com/mirastacklabs-ai/telegen/internal/instrumenter
      • 4) github.com/mirastacklabs-ai/telegen/internal/pipeline
      • 5) github.com/mirastacklabs-ai/telegen/internal/traces
      • 6) github.com/mirastacklabs-ai/telegen/internal/transform
      • 7) github.com/mirastacklabs-ai/telegen/internal/helpers/container
      • 8) github.com/mirastacklabs-ai/telegen/internal/helpers/msg
      • 9) github.com/mirastacklabs-ai/telegen/internal/ebpflogger
      • 10) github.com/mirastacklabs-ai/telegen/internal/ebpfwatcher
      • 11) github.com/mirastacklabs-ai/telegen/internal/profiler
      • 12) github.com/mirastacklabs-ai/telegen/dev/telegen/v3/internal/profiler
      • 13) github.com/mirastacklabs-ai/telegen/internal/kubei
      • 14) github.com/mirastacklabs-ai/telegen/internal/logs/filetailer
      • 15) github.com/mirastacklabs-ai/telegen/internal/cloud/unified
    • Blockers (Upstream Internal or Missing Equivalents)
    • Recommended Resolution Pattern for Blockers

Operations

  • Operations
    • Overview
    • Topics
      • Monitoring Telegen
        • Self-Telemetry
        • Key Metrics
        • Health Checks
        • Prometheus Scraping
        • Dashboard
        • Alerting
        • Logging
        • Status Commands
        • Tracing Telegen
        • Next Steps
      • Troubleshooting
        • Quick Diagnostics
        • Common Issues
        • Debug Mode
        • Getting Help
        • Next Steps
      • Upgrading Telegen
        • Version Compatibility
        • Pre-Upgrade Checklist
        • Kubernetes Upgrade
        • Docker Upgrade
        • Linux Package Upgrade
        • Configuration Migration
        • Zero-Downtime Upgrade
        • Post-Upgrade Verification
        • Troubleshooting Upgrades
        • Version-Specific Notes
        • Next Steps
      • Performance Tuning
        • Resource Guidelines
        • Ring Buffer Tuning
        • CPU Optimization
        • Memory Optimization
        • Network/Export Optimization
        • Sampling
        • Per-Feature Tuning
        • High-Volume Environments
        • Low-Resource Environments
        • Monitoring Performance
        • Benchmarking
        • Best Practices Summary
        • Next Steps
    • Quick Links

Reference

  • Reference
    • Overview
    • Topics
      • Metrics Reference
        • Self-Telemetry Metrics
        • Node Metrics (node_exporter Compatible)
        • GPU Metrics
        • LLM Inference Metrics
        • Network Flow Metrics
        • Database Metrics
        • Connection Statistics Metrics
        • Kafka Consumer Group Metrics
        • SNMP Metrics
        • Storage Array Metrics
        • Security Metrics
        • Kubernetes Metrics
        • Metric Labels
        • Metric Naming Conventions
        • Next Steps
      • Telegen Signals Reference
        • Table of Contents
        • eBPF Application Metrics
        • eBPF Application Traces
        • Network Flow Metrics
        • Service Graph Metrics
        • Span Metrics
        • Profiler Metrics
        • Node Exporter Metrics
        • Kubernetes State Metrics
        • GPU / AI-ML Metrics
        • DNS Metrics
        • Self-Telemetry Metrics
        • Sentiment Value Reference
        • Next Steps
      • VMware vCenter → MIRASTACK Data Studio Query Reference
        • 1. Overview and caveats
        • 2. Metrics catalog
        • 3. Logs catalog
        • 4. Example dashboards
        • Appendix A — Full raw metric name list
        • Appendix B — Excluded: cloud “unified” REST collector
      • NetApp ONTAP → MIRASTACK Data Studio Query Reference
        • 1. Overview and caveats
        • 2. Metrics catalog
        • 3. Logs catalog (EMS)
        • 4. Example dashboards
        • Appendix A — Enumerating metric names
        • Appendix B — Config sketch
        • Appendix C — E-Series (brief)
        • Appendix D — Catalog parity
      • Semantic Conventions
        • Overview
        • Resource Attributes
        • HTTP Span Attributes
        • gRPC Span Attributes
        • Database Span Attributes
        • Messaging Span Attributes
        • Network Attributes
        • Exception Attributes
        • Span Status
        • Span Kind
        • Metric Semantic Conventions
        • Log Semantic Conventions
        • Telegen-Specific Attributes
        • Best Practices
        • Next Steps
      • CLI Reference
        • Synopsis
        • Global Flags
        • Commands
        • Environment Variables
        • Exit Codes
        • Signal Handling
        • Debugging
        • Examples
        • Next Steps
      • API Reference
        • Overview
        • Health Endpoints
        • Metrics Endpoint
        • Status Endpoints
        • Configuration Endpoint
        • Debug Endpoints
        • Admin Endpoints
        • Authentication
        • Rate Limiting
        • CORS
        • Error Responses
        • API Versioning
        • OpenAPI Specification
        • Next Steps
    • Quick Links
Telegen
  • Getting Started
  • View page source

Getting Started

Get Telegen up and running in 5 minutes with zero configuration.

  • Quick Start Guide
    • Overview
    • Prerequisites
    • Installation Methods
    • Verify Installation
    • Targeted Instrumentation (Optional)
    • What Gets Collected
    • Next Steps
  • Core Concepts
    • Deployment Modes
    • Signal Types
    • Auto-Discovery
    • eBPF Programs
    • Resource Attributes
    • Next Steps
  • Architecture Overview
    • High-Level Architecture
    • Data Flow
    • eBPF Tracer Architecture
    • Pipeline Architecture
    • Memory Architecture
    • Security Model
    • High Availability
    • Performance Characteristics
    • Next Steps
Previous Next

© Copyright 2026, Telegen Authors.

Built with Sphinx using a theme provided by Read the Docs.