docs(tracing): update and streamline tracing guide

[Pouyanpi]

[GENERATED BY COPILOT]

This pull request revises the tracing documentation for NeMo Guardrails, streamlining the configuration process and aligning it with OpenTelemetry best practices. Key changes include simplifying the tracing setup, emphasizing application-level SDK configuration, and providing detailed examples for production and development environments.

Updates to Tracing Documentation:

Simplification of Configuration:

• Removed outdated and overly detailed examples in docs/user-guides/configuration-guide.md. The new approach focuses on enabling tracing in config.yml with minimal configuration and highlights the FileSystem and OpenTelemetry adapters for development and production use.

New Tracing Guide:

• Added docs/user-guides/tracing.md, which provides a comprehensive guide to tracing, including quick start instructions, adapter types, OpenTelemetry integration, and setup examples for development and production environments.

OpenTelemetry Best Practices:

• Updated documentation to follow OpenTelemetry standards where libraries use only the API, and applications configure the SDK. Deprecated functions like register_otel_exporter() are noted, with migration examples provided.

Enhanced Ecosystem Compatibility:

• Detailed compatibility with OpenTelemetry exporters (e.g., Jaeger, Zipkin), collectors, and backends, including setup instructions for common integrations.

Support for Custom Adapters:

• Added examples for creating and registering custom InteractionLogAdapter classes for specialized backends or formats.

#1287

[Copilot]

Pull Request Overview

This pull request revises the tracing documentation for NeMo Guardrails, streamlining the configuration process and aligning it with OpenTelemetry best practices. The documentation is restructured to provide clearer guidance for both development and production environments.

• Simplifies tracing configuration by removing complex examples and focusing on minimal configuration
• Adds a comprehensive new tracing guide with detailed OpenTelemetry integration examples
• Aligns with OpenTelemetry best practices where libraries use the API and applications configure the SDK

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
docs/user-guides/tracing.md	New comprehensive tracing guide with quick start, adapter configurations, OpenTelemetry integration examples, and migration guidance
docs/user-guides/configuration-guide.md	Streamlined tracing section with simplified configuration examples and reference to the detailed tracing guide

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.45%. Comparing base (b574cec) to head (caf0f98).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1307   +/-   ##
========================================
  Coverage    70.45%   70.45%           
========================================
  Files          161      161           
  Lines        16214    16214           
========================================
  Hits         11423    11423           
  Misses        4791     4791           

Flag	Coverage Δ
python	70.45% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[github-actions]

Documentation preview

https://nvidia.github.io/NeMo-Guardrails/review/pr-1307

[Pouyanpi]

@miyoungc merged #1310 and made the necessary adjustments 👍🏻