Skip to content

docs: define cross-SDK client telemetry conformance - #52794

Closed
xiaofan-luan wants to merge 2 commits into
milvus-io:masterfrom
xiaofan-luan:docs/client-telemetry-sdk-alignment
Closed

docs: define cross-SDK client telemetry conformance#52794
xiaofan-luan wants to merge 2 commits into
milvus-io:masterfrom
xiaofan-luan:docs/client-telemetry-sdk-alignment

Conversation

@xiaofan-luan

Copy link
Copy Markdown
Collaborator

Summary

  • update the canonical client telemetry MEP for Go, Python, Java, Node, and C++ SDKs
  • correct the 10-second heartbeat default
  • define the executable cross-SDK contract for logical operation metrics, sampling, collection scopes, command handling, reconnects, acknowledgements, and backoff
  • replace the obsolete Go-only implementation status with links to the four SDK implementations under review

The standalone milvus-design-docs repository is archived; the maintained copy now lives under docs/design-docs in this repository.

SDK implementations

Verification

  • git diff --check origin/master

@sre-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from xiaofan-luan after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@mergify

mergify Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

@xiaofan-luan

Invalid PR Title Format Detected

Your PR submission does not adhere to our required standards. To ensure clarity and consistency, please meet the following criteria:

  1. Title Format: The PR title must begin with one of these prefixes:
  • feat: for introducing a new feature.
  • fix: for bug fixes.
  • enhance: for improvements to existing functionality.
  • test: for add tests to existing functionality.
  • doc: for modifying documentation.
  • auto: for the pull request from bot.
  • build(deps): for dependency updates from Dependabot.
  1. Description Requirement: The PR must include a non-empty description, detailing the changes and their impact.

Required Title Structure:

[Type]: [Description of the PR]

Where Type is one of feat, fix, enhance, test or doc.

Example:

enhance: improve search performance significantly 

Please review and update your PR to comply with these guidelines.

@sre-ci-robot sre-ci-robot added the do-not-merge/doc-need-two-approve Gray observation: docs PR needs two distinct approve commenters label Aug 24, 2026
@sre-ci-robot

Copy link
Copy Markdown
Contributor

[approval-status] effective-owner-approvals=0 [none]; do-not-merge/disable-approve-self=not-required; do-not-merge/doc-need-two-approve=0/2 blocked; ignored=[none]

@sre-ci-robot

Copy link
Copy Markdown
Contributor

[ci-v2-notice]
Notice: New ci-v2 system is enabled for this PR.

To rerun ci-v2 checks, comment with:

  • /ci-rerun-code-check // for ci-v2/code-check
  • /ci-rerun-code-check-macos // for Code Checker MacOS (GitHub Actions)
  • /ci-rerun-build // for ci-v2/build
  • /ci-rerun-build-all // for ci-v2/build-all (multi-arch builds)
  • /ci-rerun-buildenv // for ci-v2/build-env (build milvus-env builder images; update .env after the new tag is ready)
  • /ci-rerun-ut-integration // for ci-v2/ut-integration, will rerun ci-v2/build
  • /ci-rerun-ut-go // for ci-v2/ut-go, will rerun ci-v2/build
  • /ci-rerun-ut-cpp // for ci-v2/ut-cpp
  • /ci-rerun-ut // for all ci-v2/ut-integration, ci-v2/ut-go, ci-v2/ut-cpp, will rerun ci-v2/build
  • /ci-rerun-e2e-default // for ci-v2/e2e-default
  • /ci-rerun-e2e-amd // for ci-v2/e2e-amd (e2e pool dispatcher)
  • /ci-rerun-e2e-dist-wp // for ci-v2/e2e-dist-wp (Tencent distributed woodpecker-service boundary)
  • /ci-rerun-build-ut-cov // for ci-v2/build-ut-cov (build + unit tests in one pipeline)
  • /ci-rerun-gosdk // for ci-v2/go-sdk (Go SDK E2E tests, ARM)
  • /ci-rerun-gosdk-std // for ci-v2/go-sdk-std (Go SDK E2E, standalone)
  • /ci-rerun-gosdk-dist-wp // for ci-v2/go-sdk-dist-wp (Go SDK E2E, distributed + Woodpecker service)

If you have any questions or requests, please contact @zhikunyao.

xiaofanluan added 2 commits August 23, 2026 23:29
Signed-off-by: xiaofanluan <xf@hjjaq.com>
Signed-off-by: xiaofanluan <xf@hjjaq.com>
@xiaofan-luan
xiaofan-luan force-pushed the docs/client-telemetry-sdk-alignment branch from 288bd54 to d59f835 Compare August 24, 2026 06:29
@mergify mergify Bot added the ci-passed label Aug 24, 2026
@xiaofan-luan

Copy link
Copy Markdown
Collaborator Author

Closing because the SDK work implements the existing ClientHeartbeat protocol and canonical design; no separate protocol revision is required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-passed dco-passed DCO check passed. do-not-merge/doc-need-two-approve Gray observation: docs PR needs two distinct approve commenters do-not-merge/invalid-pr-format size/M Denotes a PR that changes 30-99 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants