Apply suggestions from code review

Co-authored-by: Adam Dąbrowski <[email protected]>
RobotecAI · Sep 30, 2024 · 3c5cc3d · 3c5cc3d
1 parent bf7a1b7
commit 3c5cc3d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/developer_guide.md b/docs/developer_guide.md
@@ -94,7 +94,7 @@ agent.invoke({"messages": ["Please pick up an object and scan it."]})
 
 Additional resources:
 
-- [Tracing](tracing.md) configuration.
+- [Tracing](tracing.md) configuration for genAI models and agents.
 - [Beta demos](demos.md).
 - [Multimodal Messages](multimodal_messages.md) definition.
 - Available ROS 2 packages: [ros packages](ros_packages.md).

diff --git a/docs/tracing.md b/docs/tracing.md
@@ -1,17 +1,17 @@
 # Tracing Configuration
 
-RAI supports tracing capabilities to help monitor and analyze the performance of your AI models. This document outlines how to configure tracing for your RAI project.
+RAI supports tracing capabilities to help monitor and analyze the performance of your AI models, at a minor performance cost. By default, tracing is off. This document outlines how to configure tracing for your RAI project.
 
 ## Configuration
 
-Tracing configuration is managed through the `config.toml` file. The relevant section for tracing is as follows:
+Tracing configuration is managed through the `config.toml` file. The relevant parameters for tracing are:
 
 ### Project Name
 
 The `project` field under the `[tracing]` section sets the name for your tracing project. This name will be used to identify your project in the tracing tools.
 
 > [!NOTE]  
-> Only LangSmith project name is currently used. Langfuse will upload traces to the default project.
+> Project name is currently only used by LangSmith. Langfuse will upload traces to the default project.
 
 ### LangSmith
 
@@ -45,7 +45,7 @@ This function returns a list of callback handlers that can be used with LangChai
 If you encounter issues with tracing:
 
 1. Ensure all required environment variables are set correctly.
-2. Check that the `use_langsmith` and `use_langfuse` flags are set to `true` in `config.toml` if you intend to use these services.
+2. Check whether tracing is on by checking whether `use_langsmith` or `use_langfuse` flag is set to `true` in `config.toml`.
 3. Verify that you have the necessary permissions and valid API keys for the tracing services you're using.
 4. Look for any error messages in your application logs related to tracing initialization.