Before you start, you need two values.
- Your base endpoint — shown on Get Started in the dashboard. These
pages write it as
$OIQ_ENDPOINT. - A license key — created in Settings → License Keys, starting
oiq_. Requires the Admin role. See Create a license key. These pages write it as$OIQ_LICENSE_KEY.
Generate the configuration
You never hand-write agent configuration. The generator produces it from your endpoint and profile:Start it
The reference Compose file contains no secrets and is safe to commit.
Both the endpoint and the key are read from the environment, and Compose
refuses to start with a readable error if either is missing — rather than
starting with an empty value and failing later at ingest with a
401 you
have to trace back.A different profile
The reference file is profile B. For A or C, generate a Compose file rather than editing one by hand:What the generated service needs
Two settings carry the whole install, and both are easy to lose when merging the agent into an existing stack:Capabilities are dropped and then added back, rather than the service
being privileged. If a merge leaves you with
privileged: true, you have
granted far more than the agent needs — regenerate rather than patch.Confirm it is working
Updating configuration
Regenerate and restart:Next
Verification
Confirm data is arriving, and rule out the silent failure.
Kubernetes
The DaemonSet, for when the stack outgrows one host.
Troubleshooting
Symptom to cause to fix.