opvious/api-server repository overview

⁠Opvious API server

Opvious⁠ is a batteries-included optimization⁠ platform. This image contains a consolidated API server suitable for self-hosting.

⁠Supported tags

• latest
• <version>

⁠Usage

docker run -p 8080:8080 opvious/api-server

For many use-cases, we recommend running this image via the Opvious CLI⁠. The opvious api subcommands will transparently manage the server and its dependencies via docker compose. For example:

opvious api start # Start the server and its dependencies
opvious api logs -f # Follow API server logs

⁠License

Download and use of this image is subject to the Opvious API image EULA⁠. A separate license can be requested here⁠ to enable additional functionality, such as database persistence and asynchronous solves.

As with all Docker images, this one may also contain other software under other licenses.

⁠Telemetry

⁠Logging

Log verbosity is controlled via the LOG_LEVEL environment variable. It's possible to set the level globally and per library. trace (and to a smaller extent debug) messages are verbose and should be enabled sparingly, typically only scoped to a specific library:

LOG_LEVEL=info # Info level throughout
LOG_LEVEL=info,highs-*=debug # Info with debug for `highs-*` packages

We also recommend pino-pretty⁠ for pretty-printing logs locally.

⁠Traces

OpenTelemetry⁠-compliant traces can be exported by setting the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT environment variable to a collector's URL. You can visualize them for example by using Jaeger's all-in-one image⁠:

docker run -e COLLECTOR_OTLP_ENABLED=true -p 16686:16686 -p 4318:4318 jaegertracing/all-in-one

If you configure the API server with OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://host.docker.internal:4318/v1/traces and open your browser to http://localhost:16686⁠, you will start seeing traces.

Note that by default all traces are sampled, consider setting an explicit sampling ratio⁠ if needed.

⁠Metrics

Similarly to traces, OpenTelemetry⁠-compliant metrics can be exported by setting the OTEL_EXPORTER_OTLP_METRICS_ENDPOINT environment variable to a collector's URL.