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.
Check the host first
The kernel belongs to the host, so the requirements apply there — the base image of your workloads is irrelevant. A distroless container and a full distribution container are equally observable.perf_event_paranoid setting that must be fixed before
the default profile will collect anything.
Preview, then run
The key is redacted in the preview output, so this is safe to paste into a ticket:The two things most quickstarts get wrong
It is not
--privileged. The run script drops ALL capabilities and
adds back exactly the profile’s set. A privileged container has effectively
unrestricted host access, which is not what anyone thinks they agreed to when
installing an observability agent.Verify with docker inspect if you want to see it rather than read it.Choosing a profile
Confirm it is working
Docker Desktop
Other runtimes
The full matrix, including managed container platforms, is on
Compatibility.
Next
Docker Compose
The same agent as a service in your stack.
Verification
Confirm data is arriving.
Troubleshooting
Symptom to cause to fix.