---
title: "Collect telemetry data"
method: GET
path: "/telemetry"
tags: ["Service"]
---

# Collect telemetry data

`GET /telemetry`

Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics

## Query parameters

- `anonymize` boolean
- `details_level` integer

## Response `200`

successful operation

- object
  - `usage` union
    - HardwareUsage — Usage of the hardware resources, spent to process the request
      - `cpu` integer, required
      - `io_read` integer, required
      - `io_write` integer, required
    - unknown
  - `time` number, float — Time spent to process this request
  - `status` string
  - `result` TelemetryData
    - `id` string, required
    - `app` AppBuildTelemetry, required
      - `name` string, required
      - `version` string, required
      - `features` union
        - AppFeaturesTelemetry
          - `debug` boolean, required
          - `web_feature` boolean, required
          - `service_debug_feature` boolean, required
          - `recovery_mode` boolean, required
          - `gpu` boolean, required
        - unknown
      - `system` union
        - RunningEnvironmentTelemetry
          - `distribution` string, nullable
          - `distribution_version` string, nullable
          - `is_docker` boolean, required
          - `cores` integer, nullable
          - `ram_size` integer, nullable
          - `disk_size` integer, nullable
          - `cpu_flags` string, required
          - `cpu_endian` union
            - 'little' | 'big' | 'other'
            - unknown
          - `gpu_devices` GpuDeviceTelemetry[], nullable
            - `name` string, required
        - unknown
      - `jwt_rbac` boolean, nullable
      - `hide_jwt_dashboard` boolean, nullable
      - `startup` string, date-time, required
    - `collections` CollectionsTelemetry, required
      - `number_of_collections` integer, required
      - `collections` CollectionTelemetryEnum[], nullable
        - union
          - CollectionTelemetry
            - `id` string, required
            - `init_time_ms` integer, required
            - `config` CollectionConfigInternal, required
              - …
            - `shards` ReplicaSetTelemetry[], required
              - …
            - `transfers` ShardTransferInfo[], required
              - …
            - `resharding` ReshardingInfo[], required
              - …
            - `shard_clean_tasks` object, required
          - CollectionsAggregatedTelemetry
            - `vectors` integer, required
            - `optimizers_status` union, required — Current state of the collection
              - …
            - `params` CollectionParams, required
              - …
    - `cluster` union
      - ClusterTelemetry
        - `enabled` boolean, required
        - `status` union
          - ClusterStatusTelemetry
            - `number_of_peers` integer, required
            - `term` integer, required
            - `commit` integer, required
            - `pending_operations` integer, required
            - `role` union
              - …
            - `is_voter` boolean, required
            - `peer_id` integer, nullable
            - `consensus_thread_status` union, required — Information about current consensus thread status
              - …
          - unknown
        - `config` union
          - ClusterConfigTelemetry
            - `grpc_timeout_ms` integer, required
            - `p2p` P2pConfigTelemetry, required
              - …
            - `consensus` ConsensusConfigTelemetry, required
              - …
          - unknown
        - `peers` object, nullable
        - `metadata` object, nullable
      - unknown
    - `requests` union
      - RequestsTelemetry
        - `rest` WebApiTelemetry, required
          - `responses` object, required
        - `grpc` GrpcTelemetry, required
          - `responses` object, required
      - unknown
    - `memory` union
      - MemoryTelemetry
        - `active_bytes` integer, required — Total number of bytes in active pages allocated by the application
        - `allocated_bytes` integer, required — Total number of bytes allocated by the application
        - `metadata_bytes` integer, required — Total number of bytes dedicated to metadata
        - `resident_bytes` integer, required — Maximum number of bytes in physically resident data pages mapped
        - `retained_bytes` integer, required — Total number of bytes in virtual memory mappings
      - unknown
    - `hardware` union
      - HardwareTelemetry
        - `collection_data` object, required
      - unknown

## Other responses

- `default` — error
- `4XX` — error

## Changes

- **2025-01-17** `a7900f38a79d` — 9 breaking, 7 warning, 23 info
  - the response property `result/cluster` became optional for the status `200`
  - the response property `result/requests` became optional for the status `200`
  - added `subschema #3` to the `result/collections/collections/items/anyOf[#/components/schemas/CollectionTelemetry]/shards/items/local/anyOf[#/components/schemas/LocalShardTelemetry]/segments/items/config/payload_storage_type` response property `oneOf` list for the response status `200`
  - added `subschema #4` to the `result/collections/collections/items/anyOf[#/components/schemas/CollectionTelemetry]/transfers/items/method/anyOf[#/components/schemas/ShardTransferMethod]/` response property `oneOf` list for the response status `200`
  - …35 more
- …earlier changes not shown

[Full history](https://skmtc.dev/qdrant/apis/qdrant-api/changes/telemetry/get.md)

---

[API](https://skmtc.dev/qdrant/apis/qdrant-api.md) · [All operations](https://skmtc.dev/qdrant/apis/qdrant-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qdrant/qdrant-api/revisions/a7900f38a79d/schema)