ote

command module
v0.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2025 License: MIT Imports: 1 Imported by: 0

README

Quick Start

git clone https://github.com/clivern/ote.git
cd ote

# Copy the sample configuration and adjust values as needed
cp config.dist.yml config.prod.yml

# Run the API server with the sample config
make run

# Alternatively, run with custom config
go run ote.go server --config /path/to/config.yml

The server listens on the port defined in the configuration (app.port, defaults to 8000):

  • Health check: GET http://localhost:8000/_health
  • Prometheus metrics: GET http://localhost:8000/_metrics (basic auth; defaults admin / secret)

Deployment

The release/ directory ships two Ansible roles:

  • roles/app: Installs the Ote binary
  • roles/otel: Installs the OpenTelemetry Collector

To target a server, adjust release/inventory.yml, then run:

ansible-playbook -i release/inventory.yml release/playbook.yml

You can override versions and Dash0 credentials directly from the playbook for environment-specific values.

Testing

Run the provided make targets:

make fmt           # gofmt all Go files
make test          # run unit tests
make lint          # run revive
make ci            # execute the full quality suite

License

Distributed under the MIT License. See LICENSE for more information.

Documentation

Overview

Package main is the entry point for the Ote application.

Directories

Path Synopsis
Package api provides HTTP handlers for API endpoints.
Package api provides HTTP handlers for API endpoints.
Package cli provides command-line interface commands for the Ote application.
Package cli provides command-line interface commands for the Ote application.
Package core manages application configuration and core services.
Package core manages application configuration and core services.
Package middleware hosts HTTP middleware components.
Package middleware hosts HTTP middleware components.
Package service contains utility functions used across services.
Package service contains utility functions used across services.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL