Skip to content

feat(qdrant): Add query_batch_points, query_points and query_points_groups semantic conventions #3227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

duynguyenhoang
Copy link
Contributor

@duynguyenhoang duynguyenhoang commented Aug 4, 2025

First MR to add new qdrant sematic conventions.

  • I have added tests that cover my changes.
  • If adding a new instrumentation or changing an existing one, I've added screenshots from some observability platform showing the change.
  • PR name follows conventional commits format: feat(instrumentation): ... or fix(instrumentation): ....
  • (If applicable) I have updated the documentation accordingly.

Important

Add new Qdrant semantic conventions to SpanAttributes and update version to 0.4.13.

  • Semantic Conventions:
    • Add QDRANT_QUERY_POINTS_COLLECTION_NAME, QDRANT_QUERY_POINTS_GROUPS_COLLECTION_NAME, QDRANT_QUERY_BATCH_POINTS_COLLECTION_NAME, and QDRANT_QUERY_BATCH_POINTS_REQUESTS_COUNT to SpanAttributes in __init__.py.
  • Versioning:
    • Update version to 0.4.13 in version.py and pyproject.toml.

This description was created by Ellipsis for 3b6ec7a. You can customize this summary. It will automatically update as commits are pushed.

Summary by CodeRabbit

  • New Features
    • Added new span attributes for enhanced Qdrant query tracking, including collection names and request counts.
  • Chores
    • Updated package version to 0.4.13.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Important

Looks good to me! 👍

Reviewed everything up to 3b6ec7a in 49 seconds. Click for details.
  • Reviewed 37 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 3 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/__init__.py:239
  • Draft comment:
    New Qdrant query attributes added look consistent. Consider adding brief inline comments/docstrings to clarify their purpose.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/version.py:1
  • Draft comment:
    Version bump to 0.4.13 is correct.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
3. packages/opentelemetry-semantic-conventions-ai/pyproject.toml:11
  • Draft comment:
    pyproject.toml version updated to match version (0.4.13).
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None

Workflow ID: wflow_nfqV98J50xVK7N0Y

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

Copy link

coderabbitai bot commented Aug 4, 2025

Walkthrough

Four new Qdrant-related span attribute constants were added to the SpanAttributes class in the semantic conventions package. The package version was incremented from 0.4.12 to 0.4.13 in both the code and configuration files. No other logic or metadata was changed.

Changes

Cohort / File(s) Change Summary
Qdrant Span Attribute Additions
packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/__init__.py
Added four new Qdrant-related span attribute constants to the SpanAttributes class.
Version Bump in Code
packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/version.py
Updated __version__ from "0.4.12" to "0.4.13".
Version Bump in Config
packages/opentelemetry-semantic-conventions-ai/pyproject.toml
Updated the package version from 0.4.12 to 0.4.13.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

Four new constants hop in with glee,
Qdrant queries now tracked with ease!
A version bump, a tiny jump,
The code is fresh, the docs all plump.
🐇 With every change, we leap ahead—
Semantic trails for all to tread!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/__init__.py (1)

243-246: Maintain alphabetical order within the Qdrant section.

The block is now:

QDRANT_SEARCH_...
QDRANT_QUERY_...
QDRANT_UPLOAD_...

Placing the new QUERY_* constants after all SEARCH_* and before UPLOAD_* preserves the current alphabetical grouping and simplifies future diffs.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ee725c and 3b6ec7a.

📒 Files selected for processing (3)
  • packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/__init__.py (1 hunks)
  • packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/version.py (1 hunks)
  • packages/opentelemetry-semantic-conventions-ai/pyproject.toml (1 hunks)
🔇 Additional comments (2)
packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/version.py (1)

1-1: Version bump looks correct and consistent with pyproject.toml.

No further concerns.

packages/opentelemetry-semantic-conventions-ai/pyproject.toml (1)

11-11: Package version updated — good.

The Poetry version matches version.__version__; nothing else to change.

Comment on lines +243 to +246
QDRANT_QUERY_POINTS_COLLECTION_NAME = "qdrant.query_points.collection_name"
QDRANT_QUERY_POINTS_GROUPS_COLLECTION_NAME = "qdrant.query_points_groups.collection_name"
QDRANT_QUERY_BATCH_POINTS_COLLECTION_NAME = "qdrant.query_batch_points.collection_name"
QDRANT_QUERY_BATCH_POINTS_REQUESTS_COUNT = "qdrant.query_batch_points.requests_count"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Align new Qdrant attribute names with existing naming scheme.

Existing Qdrant attributes use the pattern qdrant.<operation>[_batch].collection_name / ...requests_count.
The newly-added constants introduce an extra “ points ” token, e.g. query_batch_points, which breaks that pattern and will sort far away from the related attributes in dashboards.

Consider renaming to keep the surface uniform:

-QDRANT_QUERY_POINTS_COLLECTION_NAME = "qdrant.query_points.collection_name"
-QDRANT_QUERY_POINTS_GROUPS_COLLECTION_NAME = "qdrant.query_points_groups.collection_name"
-QDRANT_QUERY_BATCH_POINTS_COLLECTION_NAME = "qdrant.query_batch_points.collection_name"
-QDRANT_QUERY_BATCH_POINTS_REQUESTS_COUNT = "qdrant.query_batch_points.requests_count"
+QDRANT_QUERY_COLLECTION_NAME = "qdrant.query.collection_name"
+QDRANT_QUERY_GROUPS_COLLECTION_NAME = "qdrant.query_groups.collection_name"
+QDRANT_QUERY_BATCH_COLLECTION_NAME = "qdrant.query_batch.collection_name"
+QDRANT_QUERY_BATCH_REQUESTS_COUNT = "qdrant.query_batch.requests_count"

This keeps “ query / query_batch / query_groups ” parallel to “ search / search_batch ”.

If the “points” wording is required by Qdrant’s API docs, at minimum add a short comment explaining the deviation to avoid confusion.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
QDRANT_QUERY_POINTS_COLLECTION_NAME = "qdrant.query_points.collection_name"
QDRANT_QUERY_POINTS_GROUPS_COLLECTION_NAME = "qdrant.query_points_groups.collection_name"
QDRANT_QUERY_BATCH_POINTS_COLLECTION_NAME = "qdrant.query_batch_points.collection_name"
QDRANT_QUERY_BATCH_POINTS_REQUESTS_COUNT = "qdrant.query_batch_points.requests_count"
QDRANT_QUERY_COLLECTION_NAME = "qdrant.query.collection_name"
QDRANT_QUERY_GROUPS_COLLECTION_NAME = "qdrant.query_groups.collection_name"
QDRANT_QUERY_BATCH_COLLECTION_NAME = "qdrant.query_batch.collection_name"
QDRANT_QUERY_BATCH_REQUESTS_COUNT = "qdrant.query_batch.requests_count"
🤖 Prompt for AI Agents
In
packages/opentelemetry-semantic-conventions-ai/opentelemetry/semconv_ai/__init__.py
around lines 243 to 246, the new Qdrant attribute names include an extra
"points" token that breaks the existing naming pattern and affects sorting in
dashboards. Rename these constants to remove "points" so they follow the
established pattern like qdrant.query.collection_name,
qdrant.query_groups.collection_name, and qdrant.query_batch.collection_name. If
the "points" term is required by Qdrant's API, add a brief comment explaining
this exception to maintain clarity.

Copy link
Member

@nirga nirga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@duynguyenhoang why not re-use the existing semconvs?

@duynguyenhoang
Copy link
Contributor Author

@nirga, qdrant introduced new methods and we are going to instrument them

  • query_batch_points
  • query_points
  • query_points_groups

It makes sense to add new span attributes, instead of reuse the current.
These new attributes will be used in #3228

With current package dependencies, I need to separate the MR into 2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants