Disable instrumentation by default, add instrument param to Agent, use plain OpenTelemetry (#1005)

Author: alexmojaki

docs/index.md

@@ -168,14 +168,29 @@ To understand the flow of the above runs, we can watch the agent in action using
 
 To do this, we need to set up logfire, and add the following to our code:
 
-```python {title="bank_support_with_logfire.py" hl_lines="4-6" test="skip" lint="skip"}
+```python {title="bank_support_with_logfire.py" hl_lines="6-8 20" test="skip" lint="skip"}
 ...
+from pydantic_ai import Agent, RunContext
+
 from bank_database import DatabaseConn
 
 import logfire
+
 logfire.configure()  # (1)!
 logfire.instrument_asyncpg()  # (2)!
+
 ...
+
+support_agent = Agent(
+    'openai:gpt-4o',
+    deps_type=SupportDependencies,
+    result_type=SupportResult,
+    system_prompt=(
+        'You are a support agent in our bank, give the '
+        'customer support and judge the risk level of their query.'
+    ),
+    instrument=True,
+)
 ```
 
 1. Configure logfire, this will fail if project is not set up.

docs/logfire.md

@@ -51,19 +51,27 @@ py-cli logfire projects new
 
 (Or use an existing project with `logfire projects use`)
 
-The last step is to add logfire to your code:
+Then add logfire to your code:
 
 ```python {title="adding_logfire.py"}
 import logfire
 
 logfire.configure()
 ```
 
+and enable instrumentation in your agent:
+
+```python {title="instrument_agent.py"}
+from pydantic_ai import Agent
+
+agent = Agent('openai:gpt-4o', instrument=True)
+```
+
 The [logfire documentation](https://logfire.pydantic.dev/docs/) has more details on how to use logfire,
 including how to instrument other libraries like [Pydantic](https://logfire.pydantic.dev/docs/integrations/pydantic/),
 [HTTPX](https://logfire.pydantic.dev/docs/integrations/http-clients/httpx/) and [FastAPI](https://logfire.pydantic.dev/docs/integrations/web-frameworks/fastapi/).
 
-Since Logfire is build on [OpenTelemetry](https://opentelemetry.io/), you can use the Logfire Python SDK to send data to any OpenTelemetry collector.
+Since Logfire is built on [OpenTelemetry](https://opentelemetry.io/), you can use the Logfire Python SDK to send data to any OpenTelemetry collector.
 
 Once you have logfire set up, there are two primary ways it can help you understand your application:
 
@@ -105,10 +113,10 @@ from pydantic_ai import Agent
 logfire.configure()
 logfire.instrument_httpx(capture_all=True)  # (1)!
 
-agent = Agent('openai:gpt-4o')
+agent = Agent('openai:gpt-4o', instrument=True)
 result = agent.run_sync('What is the capital of France?')
 print(result.data)
-#> The capital of France is Paris.
+# > The capital of France is Paris.
 ```
 
 1. Capture all of headers, request body, and response body.

examples/pydantic_ai_examples/chat_app.py

@@ -39,7 +39,7 @@
 # 'if-token-present' means nothing will be sent (and the example will work) if you don't have logfire configured
 logfire.configure(send_to_logfire='if-token-present')
 
-agent = Agent('openai:gpt-4o')
+agent = Agent('openai:gpt-4o', instrument=True)
 THIS_DIR = Path(__file__).parent
 
 

examples/pydantic_ai_examples/flight_booking.py

@@ -49,6 +49,7 @@ class Deps:
     system_prompt=(
         'Your job is to find the cheapest flight for the user on the given date. '
     ),
+    instrument=True,
 )
 
 

examples/pydantic_ai_examples/pydantic_model.py

@@ -25,7 +25,7 @@ class MyModel(BaseModel):
 
 model = cast(KnownModelName, os.getenv('PYDANTIC_AI_MODEL', 'openai:gpt-4o'))
 print(f'Using model: {model}')
-agent = Agent(model, result_type=MyModel)
+agent = Agent(model, result_type=MyModel, instrument=True)
 
 if __name__ == '__main__':
     result = agent.run_sync('The windy city in the US of A.')

examples/pydantic_ai_examples/question_graph.py

@@ -22,7 +22,7 @@
 # 'if-token-present' means nothing will be sent (and the example will work) if you don't have logfire configured
 logfire.configure(send_to_logfire='if-token-present')
 
-ask_agent = Agent('openai:gpt-4o', result_type=str)
+ask_agent = Agent('openai:gpt-4o', result_type=str, instrument=True)
 
 
 @dataclass

examples/pydantic_ai_examples/rag.py

@@ -48,7 +48,7 @@ class Deps:
     pool: asyncpg.Pool
 
 
-agent = Agent('openai:gpt-4o', deps_type=Deps)
+agent = Agent('openai:gpt-4o', deps_type=Deps, instrument=True)
 
 
 @agent.tool

examples/pydantic_ai_examples/roulette_wheel.py

@@ -26,9 +26,9 @@ class Deps:
     retries=3,
     result_type=bool,
     system_prompt=(
-        'Use the `roulette_wheel` function to determine if the '
-        'customer has won based on the number they bet on.'
+        'Use the `roulette_wheel` function to determine if the customer has won based on the number they bet on.'
     ),
+    instrument=True,
 )
 
 

examples/pydantic_ai_examples/sql_gen.py

@@ -97,6 +97,7 @@ class InvalidRequest(BaseModel):
     # Type ignore while we wait for PEP-0747, nonetheless unions will work fine everywhere else
     result_type=Response,  # type: ignore
     deps_type=Deps,
+    instrument=True,
 )
 
 

examples/pydantic_ai_examples/stream_markdown.py

@@ -21,7 +21,7 @@
 # 'if-token-present' means nothing will be sent (and the example will work) if you don't have logfire configured
 logfire.configure(send_to_logfire='if-token-present')
 
-agent = Agent()
+agent = Agent(instrument=True)
 
 # models to try, and the appropriate env var
 models: list[tuple[KnownModelName, str]] = [