Skip to content

README.md

Latest commit

 

History

History
133 lines (102 loc) · 4.4 KB

README.md

File metadata and controls

133 lines (102 loc) · 4.4 KB

OpAMP Provider + Consumer

This repo contains a small OpAMP provider (server) and consumer (client) setup. You can run them independently or together.

Prerequisites

  • Python 3.10+ installed
  • pip available

Quick start (provider only)

PowerShell (Windows)

cd D:\dev\opamp
python -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install -r provider\requirements.txt
scripts\run_opamp_server.cmd

Bash (Linux/macOS)

cd /path/to/opamp
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r provider/requirements.txt
./scripts/run_opamp_server.sh

The provider will start on the configured webui_port (default 8080) unless you pass --port.

Provider restore options

opamp-provider --config-path ./config/opamp.json --restore

Restores runtime state from the latest snapshot using the configured provider.state_persistence.state_file_prefix.

opamp-provider --config-path ./config/opamp.json --restore ./runtime/opamp_server_state.20260409T103000Z.json

Restores from the explicit snapshot file path.

Snapshot files use UTC timestamp suffixes: <state_file_prefix>.<YYYYMMDDTHHMMSSZ>.json. The parent folder for state_file_prefix is created automatically when snapshots are written (for example, server-state/ for server-state/opamp_server_state). If restore fails because the file is missing, corrupt, or incompatible, provider logs the error and continues with empty/default in-memory state.

Quick start (consumer only)

PowerShell (Windows)

cd D:\dev\opamp
python -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install -r consumer\requirements.txt
python -m opamp_consumer.fluentbit_client --config-path config\opamp.json

Bash (Linux/macOS)

cd /path/to/opamp
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r consumer/requirements.txt
python3 -m opamp_consumer.fluentbit_client --config-path config/opamp.json

Run provider + consumer together

PowerShell (Windows)

cd D:\dev\opamp
python -m venv .venv
.venv\Scripts\Activate.ps1
python -m pip install -r provider\requirements.txt
python -m pip install -r consumer\requirements.txt
scripts\run_opamp_server.cmd

In a new PowerShell window:

cd D:\dev\opamp
.venv\Scripts\Activate.ps1
python -m opamp_consumer.fluentbit_client --config-path config\opamp.json

Bash (Linux/macOS)

cd /path/to/opamp
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r provider/requirements.txt
python3 -m pip install -r consumer/requirements.txt
./scripts/run_opamp_server.sh

In a new shell:

cd /path/to/opamp
source .venv/bin/activate
python3 -m opamp_consumer.fluentbit_client --config-path config/opamp.json

Notes

  • Provider Web UI: http://localhost:8080/ui
  • Help page: http://localhost:8080/help
  • Latest docs redirect: http://localhost:8080/doc-set
  • Consumer diagram walkthrough (rendered PNGs): docs/consumer_client_diagrams.md
  • Consumer custom handler implementation/deployment guide: docs/consumer_custom_handlers.md
  • Consumer full update controller behavior and extension guide: docs/consumer_update_controllers.md
  • Provider/server diagram walkthrough (rendered PNGs): docs/provider_server_diagrams.md
  • Optional bearer auth setup (disabled/static/jwt): see docs/authentication.md
  • MCP client setup scripts (Claude/Codex/canonical), command-line parameters, FastMCP usage, required server parameters, and config verification commands: see ../mcp/README.md
  • Git-derived component version metadata and hook/build integration: see component_versioning.md
  • Provider state persistence/restore and snapshot retention details: see provider/README.md#state-persistence-and-restore
  • Recommended API gateway hardening and internal vs external client profiles: see docs/api_gateway_requirements.md
  • Running as a Linux daemon or Windows service (including consumer permissions to launch Fluent Bit/Fluentd): see docs/service_daemon_setup.md
  • If you change provider.webui_port in config/opamp.json, the UI/HTTP port will follow it.
  • /doc-set redirects to the URL set in provider.latest_docs_url (defaults to the project README on GitHub).
  • logs/ is created automatically by provider run scripts when log output is started.
  • For Windows CMD usage, the commands are similar but use \.venv\Scripts\activate.bat to activate the venv.