bug: wrong key 'tracing' under 'api_server'

jzhang-ippen commented 9 months ago

Describe the bug

this configuration is not working

version: 1 # should be same to the BentoML major version
api_server:
  tracing:
    exporter_type: zipkin
    sample_rate: 1.0
    zipkin:
      endpoint: "http://localhost:9411/api/v2/spans"

error

 raise BentoMLConfigException(
bentoml.exceptions.BentoMLConfigException: Invalid configuration file was given:
Key 'api_server' error:
Wrong key 'tracing' in {...}

To reproduce

use this config

version: 1 # should be same to the BentoML major version
api_server:
tracing:
exporter_type: zipkin
sample_rate: 1.0
zipkin:
  endpoint: "http://localhost:9411/api/v2/spans"

run BENTOML_CONFIG=bentoml_configuration.yaml bentoml serve

Expected behavior

the configuration should be valid according to https://docs.bentoml.com/en/v1.1.11/guides/tracing.html and https://docs.bentoml.com/en/v1.1.11/guides/configuration.html#api-server

Environment

❯ bentoml env
#### Environment variable

```bash
BENTOML_DEBUG=''
BENTOML_QUIET=''
BENTOML_BUNDLE_LOCAL_BUILD=''
BENTOML_DO_NOT_TRACK=''
BENTOML_CONFIG=''
BENTOML_CONFIG_OPTIONS=''
BENTOML_PORT=''
BENTOML_HOST=''
BENTOML_API_WORKERS=''

System information

bentoml: 1.1.11 python: 3.11.7 platform: macOS-14.2.1-arm64-arm-64bit uid_gid: 502:20 conda: 22.9.0 in_conda_env: True

conda_packages

```yaml name: dummy-service channels: - defaults dependencies: - bzip2=1.0.8=h620ffc9_4 - ca-certificates=2023.12.12=hca03da5_0 - libffi=3.4.4=hca03da5_0 - ncurses=6.4=h313beb8_0 - openssl=3.0.12=h1a28f6b_0 - pip=23.3.1=py311hca03da5_0 - python=3.11.7=hb885b13_0 - readline=8.2=h1a28f6b_0 - setuptools=68.2.2=py311hca03da5_0 - sqlite=3.41.2=h80987f9_0 - tk=8.6.12=hb8d0fd4_0 - wheel=0.41.2=py311hca03da5_0 - xz=5.4.5=h80987f9_0 - zlib=1.2.13=h5a0b063_0 - pip: - aiohttp==3.9.1 - aiosignal==1.3.1 - annotated-types==0.6.0 - anyio==4.2.0 - appdirs==1.4.4 - asgiref==3.7.2 - attrs==23.2.0 - backoff==2.2.1 - bentoml==1.1.11 - boto3==1.34.38 - botocore==1.34.38 - build==1.0.3 - cattrs==23.1.2 - certifi==2023.11.17 - chardet==4.0.0 - circus==0.18.0 - click==7.1.2 - click-option-group==0.5.6 - cloudpickle==3.0.0 - contextlib2==21.6.0 - deepmerge==1.1.1 - deprecated==1.2.14 - fastapi==0.109.2 - filelock==3.13.1 - filetype==1.2.0 - frozenlist==1.4.1 - fs==2.4.16 - fs-s3fs==1.1.1 - fsspec==2023.12.2 - googleapis-common-protos==1.56.2 - grpcio==1.60.1 - grpcio-channelz==1.48.2 - grpcio-health-checking==1.48.2 - grpcio-reflection==1.48.2 - h11==0.14.0 - httpcore==0.17.3 - httpx==0.24.1 - idna==2.10 - importlib-metadata==6.11.0 - inflection==0.5.1 - iniconfig==2.0.0 - jinja2==3.1.3 - jmespath==1.0.1 - joblib==1.3.2 - markdown-it-py==3.0.0 - markupsafe==2.1.4 - mdurl==0.1.2 - mpmath==1.3.0 - multidict==6.0.4 - networkx==3.2.1 - numpy==1.26.4 - nvidia-ml-py==11.525.150 - opentelemetry-api==1.20.0 - opentelemetry-exporter-jaeger==1.20.0 - opentelemetry-exporter-jaeger-proto-grpc==1.20.0 - opentelemetry-exporter-jaeger-thrift==1.20.0 - opentelemetry-exporter-otlp==1.20.0 - opentelemetry-exporter-otlp-proto-common==1.20.0 - opentelemetry-exporter-otlp-proto-grpc==1.20.0 - opentelemetry-exporter-otlp-proto-http==1.20.0 - opentelemetry-exporter-zipkin==1.20.0 - opentelemetry-exporter-zipkin-json==1.20.0 - opentelemetry-exporter-zipkin-proto-http==1.20.0 - opentelemetry-instrumentation==0.41b0 - opentelemetry-instrumentation-aiohttp-client==0.41b0 - opentelemetry-instrumentation-asgi==0.41b0 - opentelemetry-instrumentation-grpc==0.41b0 - opentelemetry-proto==1.20.0 - opentelemetry-sdk==1.20.0 - opentelemetry-semantic-conventions==0.41b0 - opentelemetry-util-http==0.41b0 - packaging==23.2 - pandas==2.2.0 - pathspec==0.12.1 - pillow==10.2.0 - pip-requirements-parser==32.0.1 - pip-tools==6.10.0 - pluggy==1.4.0 - polars==0.20.7 - prometheus-client==0.19.0 - prometheusrock==0.2.0 - protobuf==3.20.3 - psutil==5.9.8 - pyarrow==15.0.0 - pydantic==2.6.1 - pydantic-core==2.16.2 - pygments==2.17.2 - pyparsing==3.1.1 - pyproject-hooks==1.0.0 - pytest==7.4.4 - python-dateutil==2.8.2 - python-dotenv==0.17.1 - python-json-logger==2.0.7 - python-multipart==0.0.6 - pytigergraph==1.5.1 - pytz==2024.1 - pyyaml==6.0.1 - pyzmq==25.1.2 - requests==2.25.1 - rich==13.7.0 - s3transfer==0.10.0 - schema==0.7.5 - scikit-learn==1.4.0 - scipy==1.12.0 - simple-di==0.1.5 - six==1.16.0 - sniffio==1.3.0 - starlette==0.36.3 - sympy==1.12 - threadpoolctl==3.2.0 - thrift==0.16.0 - torch==2.1.2 - torch-geometric==2.4.0 - tornado==6.4 - tqdm==4.66.1 - typing-extensions==4.9.0 - tzdata==2023.4 - urllib3==1.26.18 - uvicorn==0.13.4 - validators==0.22.0 - watchfiles==0.21.0 - wrapt==1.16.0 - yarl==1.9.4 - zipp==3.17.0 prefix: /Users/jzhang/opt/miniconda3/envs/dummy-service ```

pip_packages

``` aiohttp==3.9.1 aiosignal==1.3.1 annotated-types==0.6.0 anyio==4.2.0 appdirs==1.4.4 asgiref==3.7.2 attrs==23.2.0 backoff==2.2.1 bentoml==1.1.11 boto3==1.34.38 botocore==1.34.38 build==1.0.3 cattrs==23.1.2 certifi==2023.11.17 chardet==4.0.0 circus==0.18.0 click==7.1.2 click-option-group==0.5.6 cloudpickle==3.0.0 contextlib2==21.6.0 deepmerge==1.1.1 Deprecated==1.2.14 fastapi==0.109.2 filelock==3.13.1 filetype==1.2.0 frozenlist==1.4.1 fs==2.4.16 fs-s3fs==1.1.1 fsspec==2023.12.2 googleapis-common-protos==1.56.2 grpcio==1.60.1 grpcio-channelz==1.48.2 grpcio-health-checking==1.48.2 grpcio-reflection==1.48.2 h11==0.14.0 httpcore==0.17.3 httpx==0.24.1 idna==2.10 importlib-metadata==6.11.0 inflection==0.5.1 iniconfig==2.0.0 Jinja2==3.1.3 jmespath==1.0.1 joblib==1.3.2 markdown-it-py==3.0.0 MarkupSafe==2.1.4 mdurl==0.1.2 mpmath==1.3.0 multidict==6.0.4 networkx==3.2.1 numpy==1.26.4 nvidia-ml-py==11.525.150 opentelemetry-api==1.20.0 opentelemetry-exporter-jaeger==1.20.0 opentelemetry-exporter-jaeger-proto-grpc==1.20.0 opentelemetry-exporter-jaeger-thrift==1.20.0 opentelemetry-exporter-otlp==1.20.0 opentelemetry-exporter-otlp-proto-common==1.20.0 opentelemetry-exporter-otlp-proto-grpc==1.20.0 opentelemetry-exporter-otlp-proto-http==1.20.0 opentelemetry-exporter-zipkin==1.20.0 opentelemetry-exporter-zipkin-json==1.20.0 opentelemetry-exporter-zipkin-proto-http==1.20.0 opentelemetry-instrumentation==0.41b0 opentelemetry-instrumentation-aiohttp-client==0.41b0 opentelemetry-instrumentation-asgi==0.41b0 opentelemetry-instrumentation-grpc==0.41b0 opentelemetry-proto==1.20.0 opentelemetry-sdk==1.20.0 opentelemetry-semantic-conventions==0.41b0 opentelemetry-util-http==0.41b0 packaging==23.2 pandas==2.2.0 pathspec==0.12.1 pillow==10.2.0 pip-requirements-parser==32.0.1 pip-tools==6.10.0 pluggy==1.4.0 polars==0.20.7 prometheus-client==0.19.0 prometheusrock==0.2.0 protobuf==3.20.3 psutil==5.9.8 pyarrow==15.0.0 pydantic==2.6.1 pydantic_core==2.16.2 Pygments==2.17.2 pyparsing==3.1.1 pyproject_hooks==1.0.0 pytest==7.4.4 python-dateutil==2.8.2 python-dotenv==0.17.1 python-json-logger==2.0.7 python-multipart==0.0.6 pyTigerGraph==1.5.1 pytz==2024.1 PyYAML==6.0.1 pyzmq==25.1.2 requests==2.25.1 rich==13.7.0 s3transfer==0.10.0 schema==0.7.5 scikit-learn==1.4.0 scipy==1.12.0 simple-di==0.1.5 six==1.16.0 sniffio==1.3.0 starlette==0.36.3 sympy==1.12 threadpoolctl==3.2.0 thrift==0.16.0 torch==2.1.2 torch_geometric==2.4.0 tornado==6.4 tqdm==4.66.1 typing_extensions==4.9.0 tzdata==2023.4 urllib3==1.26.18 uvicorn==0.13.4 validators==0.22.0 watchfiles==0.21.0 wrapt==1.16.0 yarl==1.9.4 zipp==3.17.0 ```

jianshen92 commented 9 months ago

Tracing should be a top level key instead of under api_server

See example of the default config here https://github.com/bentoml/BentoML/blob/main/src/bentoml/_internal/configuration/v1/default_configuration.yaml

jzhang-ippen commented 9 months ago

please update the documentation because it's now misleading. https://docs.bentoml.com/en/v1.1.11/guides/configuration.html#api-server says it's under api_server but it should not be the case.

jianshen92 commented 9 months ago

Thanks for spotting this @jzhang-ippen!

@Sherlock113 bringing this to your attention

bentoml / BentoML