Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Botanu adds **runs** on top of distributed tracing. A run represents a single bu
```python
from botanu import enable, botanu_use_case

enable(service_name="my-app")
enable(service_name="my-service")

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
result = llm.analyze(order)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = llm.complete(...)
return result
```

Expand Down
31 changes: 15 additions & 16 deletions docs/api/decorators.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ from botanu import botanu_use_case
```python
from botanu import botanu_use_case

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
result = llm.analyze(order)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = llm.complete(...)
return result
```

Expand All @@ -53,9 +53,9 @@ def process_order(order_id: str):
```python
from botanu import use_case

@use_case(name="process_order")
def process_order(order_id: str):
return db.get_order(order_id)
@use_case(name="my_workflow")
def my_function():
return db.query(...)
```

## @botanu_outcome
Expand All @@ -79,19 +79,18 @@ def extract_data():
```python
from botanu import botanu_use_case, botanu_outcome

@botanu_use_case(name="data_pipeline")
def run_pipeline():
extract_data()
transform_data()
load_data()
@botanu_use_case(name="my_workflow")
def my_function():
step_one()
step_two()

@botanu_outcome()
def extract_data():
return fetch_from_source()
def step_one():
return do_work()

@botanu_outcome()
def transform_data():
return apply_transformations()
def step_two():
return do_more_work()
```

## See Also
Expand Down
21 changes: 10 additions & 11 deletions docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ enable(service_name="my-service")
```python
from botanu import botanu_use_case

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
result = llm.analyze(order)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = llm.complete(...)
return result
```

Expand All @@ -40,16 +40,15 @@ All LLM calls, database queries, and HTTP requests inside the function are autom
```python
from botanu import enable, botanu_use_case

enable(service_name="order-service")
enable(service_name="my-service")

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = openai.chat.completions.create(
model="gpt-4",
messages=[{"role": "user", "content": order.description}]
messages=[{"role": "user", "content": data}]
)
db.save_result(order_id, result)
return result
```

Expand All @@ -58,7 +57,7 @@ def process_order(order_id: str):
| Attribute | Example | Description |
|-----------|---------|-------------|
| `botanu.run_id` | `019abc12-...` | Unique run identifier |
| `botanu.use_case` | `process_order` | Business use case |
| `botanu.use_case` | `my_workflow` | Business use case |
| `gen_ai.usage.input_tokens` | `150` | LLM input tokens |
| `gen_ai.usage.output_tokens` | `200` | LLM output tokens |
| `db.system` | `postgresql` | Database system |
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ Botanu introduces **run-level attribution**: a unique `run_id` that follows your
```python
from botanu import enable, botanu_use_case

enable(service_name="my-app")
enable(service_name="my-service")

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
result = llm.analyze(order)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = llm.complete(...)
return result
```

Expand Down
8 changes: 4 additions & 4 deletions docs/integration/auto-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ from botanu import enable, botanu_use_case

enable(service_name="my-service")

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = openai.chat.completions.create(
model="gpt-4",
messages=[{"role": "user", "content": order.description}]
messages=[{"role": "user", "content": data}]
)
return result
```
Expand Down
10 changes: 5 additions & 5 deletions docs/integration/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,11 +253,11 @@ from botanu import enable, botanu_use_case

enable(service_name="entry-service")

@botanu_use_case(name="process_order")
def process_order(order_id: str):
order = db.get_order(order_id)
result = llm.analyze(order)
notify_service.send(result)
@botanu_use_case(name="my_workflow")
def my_function():
data = db.query(...)
result = llm.complete(...)
downstream_service.call(result)
return result
```

Expand Down
Loading