DOCSEARCHbyAlgolia
Submit Docs

PingCAP Clinic Documentation

website·Indexed 30 days ago

https://clinic-docs-en.vercel.app/docs

Documentation for the PingCAP Clinic Diagnostic Service, including release notes for v1.0.0 and Diag v1.3.0, service agreements, and data collection guides.

Tokens
1.3K
Snippets
3
Records
12
Agent score
72%

What's inside PingCAP Clinic

  1. Overview of PingCAP Clinic Diagnostic Service

    PingCAP Clinic is a diagnostic service for TiDB clusters deployed via TiUP or TiDB Operator. It enables remote troubleshooting and local cluster status checks to ensure stability, predict potential issues, and accelerate problem resolution throughout the cluster life-cycle.

  2. Overview of PingCAP Clinic Diagnostic Service

    PingCAP Clinic is a diagnostic service for TiDB clusters deployed via TiUP or TiDB Operator. It enables remote troubleshooting and local cluster status checks to predict, reduce, and fix cluster problems throughout the cluster's life-cycle. Depending on data residency requirements, users can choose between two server locations:

  3. Understand PingCAP Clinic service capabilities and usage constraints

    PingCAP Clinic is a cloud diagnostic service platform for TiDB database clusters that provides data upload, storage, display, and smart analysis. Key operational constraints include:

    • Data Upload: Services only accept TiDB cluster diagnostic data that has been collected, packaged, and encrypted by the official Clinic client. Data not meeting these specifications is deleted immediately.
    • Data Integrity: PingCAP does not modify or edit uploaded content.
    • Prohibited Actions: Users must not abuse the service by packaging non-Clinic client data into packets or disguising diagnostic data for upload.

  4. Manage data during PingCAP Clinic Technical Preview

    During the Technical Preview stage (the period before the GA version release), the following conditions apply:

    • Data Persistence: Data uploaded during Technical Preview may not be available after the official GA version is released.
    • Availability: There are no guaranteed service availability standards; updates to background programs may cause user operations to fail.
    • Account Inactivity: If a user does not log into the service within 60 days after registration, PingCAP reserves the right to empty the account data without prior notice. No data recovery services are provided for this action.

  6. Understand intellectual property restrictions for PingCAP Clinic

    Users of PingCAP Clinic services are prohibited from modifying, adapting, translating, or creating derivative works of PingCAP software, technology, or materials. Specifically, obtaining source code through reverse engineering, decompilation, or disassembly is strictly forbidden. Users are also prohibited from maliciously modifying, copying, or distributing these assets. Intellectual property rights remain solely with the respective owning party.

  7. Handle diagnostic data privacy and sharing in PingCAP Clinic

    The handling of diagnostic data in PingCAP Clinic is governed by the following rules:

    • Authorization: By actively uploading data, users authorize PingCAP and its employees (and reliable suppliers like AWS) to transmit, store, copy, and process the data for diagnostic assistance.
    • Public Sharing: Users can choose to share diagnostic data with non-PingCAP staff. Once shared publicly, PingCAP cannot compel others to delete that data. Users can stop sharing at any time.
    • Third-Party Disclosure: Non-public content is not disclosed to third parties except for reliable service providers or when required by law, emergencies, or to protect PingCAP's legal rights.

  8. Handle confidential information in PingCAP Clinic services

    Confidential Information includes non-public business, operational, and technical data (e.g., business plans, user information, service prices). The receiving party must maintain confidentiality and not disclose information to third parties without written consent. Information is not considered confidential if it was already known, is in the public domain, was legally obtained from a third party, or was independently developed. Confidentiality obligations persist beyond the contract term until the information is no longer confidential.

  9. Review PingCAP Clinic service risks and liability limits

    PingCAP Clinic services are provided 'as-is' based on current technical capabilities. PingCAP is not liable for service interruptions caused by force majeure, telecommunications failures, network security incidents (e.g., viruses, hacker attacks), or unauthorized user operation.

    Liability Cap: The total liability of PingCAP to the user for any claim related to the services shall not exceed the total amount paid by the user to PingCAP in the twelve (12) months preceding the loss.

  10. Disable metrics compression in Diag

    To collect metrics without compression in Diag (v1.1.0+), use the --compress-metrics=false flag during the collection process.
    # Example usage of the flag
--compress-metrics=false

  11. Exclude specific logs during Diag collection

    Diag (v0.8.0+) supports refined classification for log collection. You can exclude specific logs, such as slow logs, to avoid collecting sensitive data using the --exclude flag.
    # Exclude slow logs from collection
--exclude=log.slow

  12. Collect metrics without PD using tiup diag util metricdump

    In Diag v1.1.0 and later, you can collect metrics without a Placement Driver (PD) using the metricdump utility. To see detailed usage and options, run the help command for the utility.
    tiup diag util metricdump -h