Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.2 KB

tracing.rst

File metadata and controls

83 lines (56 loc) · 2.2 KB
Raw

Tracing

BentoML API server supports tracing with both Zipkin and Jaeger. To config tracing server, user can provide a config YAML file specifying the tracer type and tracing server information:

tracing:
  type: jaeger
  zipkin:
    url: http://localhost:9411/api/v2/spans
  jaeger:
    address: localhost
    port: 6831

Here's an example config for tracing with a Zipkin server:

tracing:
   type: zipkin
   zipkin:
     url: http://localhost:9411/api/v2/spans

When using Zipkin tracer, BentoML only supports its v2 protocol. If you are reporting to the an OpenZipkin server directly, make sure to add the URL path /api/v2/spans to the server address.

Here is another example config file for tracing with Jaeger and opentracing:

tracing:
  type: jaeger
  jaeger:
    address: localhost
    port: 6831

If you would like to exclude some routes from tracing, you can specify them using the excluded_urls parameter. This parameter can be either a comma-separated string of routes, or a list of strings.

tracing:
  type: jaeger
  jaeger:
    address: localhost
    port: 6831
  excluded_urls: readyz,livez,healthz,static_content,docs,metrics

When starting a BentoML API model server, provide the path to this config file via the CLI argument `--config`:

bentoml serve $BENTO_BUNDLE_PATH --config my_config_file.yml

After BentoML v0.13.0, user will need to provide the config file path via environment variable BENTOML_CONFIG:

BENTOML_CONFIG=my_config_file.yml bentoml serve $BENTO_BUNDLE_PATH

Similarly when serving with BentoML API server docker image, assuming you have a my_config_file.yml file ready in current directory:

docker run -v $(PWD):/tmp my-bento-api-server -p 3000:3000 --config /tmp/my_config_file.yml

# after version 0.13.0
docker run -v $(PWD):/tmp -p 3000:3000 -e BENTOML_CONFIG=/tmp/my_config_file.yml my-bento-api-server

opentracing