Observe Agent

Code for the Observe agent and CLI. The agent code is based on the OpenTelemetry Collector.

Configuration

See https://docs.observeinc.com/en/latest/content/observe-agent/configuration.html for observe-agent configuration documentation. We also offer a json schema for the observe-agent config file, which can be added to editors to provide autocomplete and validation. The schema can be found at https://github.com/observeinc/observe-agent/releases/latest/download/observe-agent.schema.json.

Build

To run the code you need to have golang v1.25.8 installed. Then you can run the following command to compile the binary.

go build -o observe-agent

Installing local builds on Mac or Linux

To install a local build of the agent as a Mac Launch Daemon or Linux Systemd service, run the following commands. First, build the release snapshot:

goreleaser release --snapshot --clean --verbose --single-target

Then, run the agent install script, pointing it to the snapshot build:

# For Mac
ZIP_DIR=./dist/darwin_arm64_v8.0/observe-agent_Darwin_arm64.zip ./scripts/install_mac.sh --token <token> --observe_url <observe_url>

or

# For Linux
ZIP_DIR=./dist/linux_amd64_v1/observe-agent_Linux_x86_64.tar.gz ./scripts/install_linux.sh --token <token> --observe_url <observe_url>

Updating dependencies

Before adding new components or updating existing ones, you'll need to install the Otel Collector Builder tool. If you're running on mac and arm64 (M chips) you can run the following command

make install-ocb

Otherwise, see instructions to install at [https://opentelemetry.io/docs/collector/custom-collector/#step-1---install-the-builder]

To add or modify components, you can modify the builder-config.yaml file. Make changes the correct section (e.g.: receivers, processors, etc.) and then run the following command.

make build-ocb

This command should update dependencies and code in the correct places. You can build the agent afterwards with go build to confirm.

Afterwards, run make generate-readme to regenerate the Components section below.

Running

To start the observe agent after building the binary run the following command.

./observe-agent start

Components

Current OTEL Collector Version: v0.147.0

This section lists the components that are included in the Observe Distribution of the OpenTelemetry Collector.

Receivers	Processors	Exporters	Extensions	Connectors
awsecscontainermetrics	attributes	debug	cgroupruntime	count
docker_stats	batch	file	file_storage	forward
elasticsearch	cumulativetodelta	loadbalancing	health_check	routing
filelog	deltatocumulative	nop	pprof	spanmetrics
filestats	filter	otlp	zpages
heartbeat	groupbyattrs	otlphttp
hostmetrics	k8sattributes	prometheus
httpcheck	logdedup	prometheusremotewrite
iis	memory_limiter	syslog
jmx	metricstransform
journald	observek8sattributes
k8s_cluster	probabilisticsampler
k8sobjects	redaction
kafka	resource
kafkametrics	resourcedetection
kubeletstats	span
mongodb	tailsampling
nop	transform
otlp
postgresql
prometheus
redis
snmp
sqlquery
sqlserver
statsd
syslog
tcplog
udplog
windowseventlog