Developer Knowledgebase & Architecture Docs

How can we help your Engineering Team?

Explore step-by-step SDK guides, W3C trace context standards, environment variables, and configuration blueprints for sovereign cloud environments.

Quickstart SDK Installation

Install binary agents or lightweight middleware packages in under 2 minutes.

OpenTelemetry v1.28+ Compatible

Go SDK Quickstart

Backend

Easy setup for Gin, Fiber, Chi, or net/http web apps.

go get github.com/trustportidentity/beacon-go
Production readyRead Full Go Guide

Node.js & NestJS SDK

TypeScript

Fast setup for Express, Fastify, and NestJS apps.

npm install @trusportidentity/beacon-node
Production readyRead Full Node.js Setup

Laravel PHP SDK

PHP 8.2+

Requests with users, queries, queues, cache, logs, exceptions and PHP fatals. Nightwatch migration guide included.

composer require trustportidentity/beacon-laravel:^1.2
Production readyRead Full Laravel Setup

Python & FastAPI SDK

Python 3.10+

Simple setup for FastAPI and Flask apps with database tracking.

pip install trustportidentity-beacon
Production readyRead Full Python Docs

Docker & Kubernetes Sidecar

DevOps

Collect Kubernetes network and container metrics without changing your code.

helm repo add trustport https://charts.trustportidentity.com
Production readyRead Full Helm Setup

Complete SDK Integration Blueprints

Select your runtime to inspect production-ready initialization code.

main.go
package main

import (
    "github.com/gin-gonic/gin"
    "github.com/trustportidentity/beacon-go"
)

func main() {
    // Initialize TrustPort Beacon SDK with your License Key
    beacon.Init(beacon.Config{
        IngestURL:   "https://beacon-api.trustportidentity.com",
        APIKey:      "tp_live_9f8a3c4e12", // License Key from Console
        ServiceName: "payment-service",
        Environment: "production",
    })
    defer beacon.Close()

    r := gin.Default()

    // Attach automatic trace middleware
    r.Use(beacon.GinMiddleware("payment-service"))

    r.POST("/api/v1/charge", func(c *gin.Context) {
        ctx := c.Request.Context()
        
        // Record custom trace span for database query
        span := beacon.StartSpan(ctx, "db.query.charge_account")
        defer span.End()

        c.JSON(200, gin.H{"status": "charged", "trace_id": beacon.TraceID(ctx)})
    })

    r.Run(":8080")
}
Standard Compliance

W3C Trace Context Specification

TrustPort Beacon strictly adheres to the official W3C Distributed Tracing recommendation. Spans are connected via the universal traceparent header across every network hop.

# W3C Header Format:version-trace_id (32 hex)-parent_id (16 hex)-trace_flags
# Live Ingestion Header Example:traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
Zero vendor lock-in
OpenTelemetry native

Environment Variables Reference

BEACON_INGEST_URL
URL of your sovereign ingestion node: http://localhost:8443 or UK-1 cluster endpoint.
BEACON_API_KEY
Cryptographic ingest token (begins with tp_live_...).
BEACON_SERVICE_NAME
Canonical microservice identifier (e.g., api-gateway, auth-service).
BEACON_ENVIRONMENT
Deployment environment tag (production, staging).

Frequently Asked Developer Questions

Technical answers regarding eBPF overhead, ring buffer fallback, and air-gapped deployments.

The TrustPort agent runs directly in the Linux kernel to watch network traffic. It measures app performance accurately with almost zero effect on CPU usage.

Need hands-on deployment support?

Our sovereign engineering support team is available 24/7 to assist with cluster installations, air-gapped deployments, and custom OpenTelemetry collectors.