New manual tracing docs (#257)

pydantic · Jun 11, 2024 · a3dae07 · a3dae07
1 parent d88fd08
commit a3dae07
Show file tree

Hide file tree

Showing 11 changed files with 207 additions and 217 deletions.
diff --git a/docs/guides/first_steps/index.md b/docs/guides/first_steps/index.md
@@ -2,23 +2,6 @@ This guide will walk you through getting started with **Logfire**.
 You'll learn how to install Logfire, authenticate your local environment,
 and use traces and spans to instrument your code for observability.
 
-## OpenTelemetry Concepts
-
-Before diving in, let's briefly cover two fundamental OpenTelemetry concepts:
-
-- **Traces:** A trace represents the entire journey of a request or operation as it moves through a
-  (possibly distributed) system. It's composed of one or more spans.
-- **Spans:** A span represents a unit of work within a trace, and are a way to track the execution of your code.
-  Unlike traditional logs, which contain a message at a single moment in time, spans can be nested to form a tree-like
-  structure, with a root span representing the overall operation, and child spans representing sub-operations.
-  Spans are used to measure timing and record metadata about the work being performed.
-
-In Logfire, we'll frequently visualize traces as a tree of its spans:
-
-![Example trace screenshot](../../images/logfire-screenshot-first-steps-example-trace.png)
-
-Using traces and spans, you can gain valuable insights into your system's behavior and performance.
-
 ## Installation {#install}
 
 To install the latest version of **Logfire**, run:

diff --git a/docs/guides/onboarding_checklist/add_manual_tracing.md b/docs/guides/onboarding_checklist/add_manual_tracing.md
diff --git a/docs/images/guide/manual-tracing-attribute-hello-world.png b/docs/images/guide/manual-tracing-attribute-hello-world.png
diff --git a/docs/images/guide/manual-tracing-basic-closed-span.png b/docs/images/guide/manual-tracing-basic-closed-span.png
diff --git a/docs/images/guide/manual-tracing-basic.png b/docs/images/guide/manual-tracing-basic.png
diff --git a/docs/images/guide/manual-tracing-default-levels.png b/docs/images/guide/manual-tracing-default-levels.png
diff --git a/docs/images/guide/manual-tracing-explore-basic.png b/docs/images/guide/manual-tracing-explore-basic.png
diff --git a/docs/images/guide/manual-tracing-level-colors.png b/docs/images/guide/manual-tracing-level-colors.png
diff --git a/docs/images/guide/manual-tracing-span-names.png b/docs/images/guide/manual-tracing-span-names.png
diff --git a/docs/images/guide/manual-tracing-traceback.png b/docs/images/guide/manual-tracing-traceback.png
diff --git a/logfire/_internal/config.py b/logfire/_internal/config.py
@@ -212,7 +212,8 @@ def configure(
             If it returns `None`, the value is redacted.
             Otherwise, the returned value replaces the matched value.
             The function accepts a single argument of type [`logfire.ScrubMatch`][logfire.ScrubMatch].
-        inspect_arguments: Whether to enable f-string magic.
+        inspect_arguments: Whether to enable
+            [f-string magic](https://docs.pydantic.dev/logfire/guides/onboarding_checklist/add_manual_tracing/#f-strings).
             If `None` uses the `LOGFIRE_INSPECT_ARGUMENTS` environment variable.
             Defaults to `True` if and only if the Python version is at least 3.11.
     """