Skip to content

Commit 72929af

Browse files
committed
add script and doc
1 parent b90510d commit 72929af

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

ibis-server/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,13 @@ Run the server
7878
just run
7979
```
8080

81+
### Enable Tracing
82+
We uses OpenTelemetry as its tracing framework. Refer to OpenTelemetry zero-code instrumentation to install the required dependencies.
83+
Then, use the following just command to start the Ibis server, which exports tracing logs to the console:
84+
```
85+
just run-trace-console
86+
```
87+
OpenTelemetry zero-code instrumentation is highly configurable. You can set the necessary exporters to send traces to your tracing services.
88+
8189
## Contributing
8290
Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more information.

ibis-server/justfile

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ port := "8000"
2323
run:
2424
poetry run fastapi run --port {{ port }}
2525

26+
run-trace-console:
27+
opentelemetry-instrument --traces_exporter console --metrics_exporter none fastapi run --port {{ port }}
28+
2629
dev:
2730
poetry run fastapi dev --port {{ port }}
2831

0 commit comments

Comments
 (0)