Install the agent

The SouthBase agent is an OpenTelemetry Collector distribution, Apache-2.0, running in your own infrastructure.

Not yet released

The agent is under development and has not been published. Install commands below are the intended shape, not working instructions. Ship date: Week 8 — see docs/planning/SPRINT-PLAN.md.

What it is

The SouthBase agent is a distribution of the OpenTelemetry Collector, not a bespoke daemon. If you already run the Collector, this is the same binary with three additional processors — the same config format, the same operational model, nothing new to learn.

It is Apache-2.0 and runs entirely inside your infrastructure.

Why it is open source

The agent handles your telemetry before that telemetry leaves your network. You are entitled to read exactly what it does with it — particularly the redaction processor, whose whole promise is that sensitive data never reaches us.

It does not phone home. It collects no telemetry about its own users. If you see it connect anywhere other than the endpoint you configured, that is a bug and we want the report.

Configuration

receivers:
  otlp:
    protocols:
      http:
      grpc:

processors:
  redaction:      # mask sensitive fields before anything leaves the network
    policy: default-pii-v1
  tokennorm:      # normalize provider usage into the four buckets
  costenrich:     # attach cost from the bundled price book
  batch:

exporters:
  otlp:
    endpoint: ingest.southbase.dev:443
    headers:
      authorization: "Bearer ${SOUTHBASE_API_KEY}"

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [redaction, tokennorm, costenrich, batch]
      exporters: [otlp]

Order matters: redaction runs first, so nothing downstream — including our own processors — ever sees an unmasked payload.

Next

On this page