{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/cli/redis-di-describe",
  "title": "redis-di describe",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-describe/",
  "summary": "Describes a pipeline with its status",
  "aliases": [
    "/integrate/redis-data-integration/reference/cli/redis-di-status/"
  ],
  "tags": [
    "redis-di"
  ],
  "last_updated": "2026-09-18T16:41:35+01:00",
  "page_type": "content",
  "content_hash": "e91d972fd269058a608f9cf14c9c20b7b5938167b8455e3e1b59cef55e9ae0a0",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Describes a pipeline, combining its configuration with its runtime status, components, errors, and\nmetrics in a human-readable, sectioned layout. `status` is an alias for this command.\n\nThe RDI version is not shown here, because it is a property of the API connection rather than of the\npipeline; use [`info`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-info)\nto see it."
    },
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]\n\nThe pipeline name is an optional argument that defaults to `default`."
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "This command takes only the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di#global-options)."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]\n\nTo watch the status update live, pair the command with `watch`:\n\n[code example]\n\nThe output has a section for each part of the pipeline. The example below shows a pipeline with\ntwo sources, `mysql` and `postgresql`:\n\n[code example]\n\nThe `Metrics Endpoints` column shows the externally-reachable metrics URLs of each component,\nwhich RDI discovers from the component's `Ingress` resources. It is empty for a component that\nhas no ingress, or while the ingress controller has not assigned an address yet. See\n[Accessing the metrics](https://redis.io/docs/latest/integrate/redis-data-integration/observability#accessing-the-metrics) for more information."
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "redis-di describe [pipeline] [flags]",
      "section_id": "usage"
    },
    {
      "id": "example-ex0",
      "language": "bash",
      "code": "redis-di describe\nredis-di status my-pipeline",
      "section_id": "example"
    },
    {
      "id": "example-ex1",
      "language": "bash",
      "code": "watch -n 1 redis-di describe",
      "section_id": "example"
    },
    {
      "id": "example-ex2",
      "language": "plaintext",
      "code": "Name:     default\nActive:   yes\nStatus:   started\nCurrent:  yes\n\nSources:\n  Name        Type  Db Type     Connection              Sync Mode  Connected\n  ----        ----  -------     ----------              ---------  ---------\n  mysql       cdc   mysql       <mysql-host>:3306       streaming  yes\n  postgresql  cdc   postgresql  <postgresql-host>:5432  streaming  yes\n\nTargets:\n  Name    Db Type  Connection                 Connected\n  ----    -------  ----------                 ---------\n  target  redis    <redis-target-host>:12000  yes\n\nProcessor:\n  Type:  flink\n\nJobs:\n  Name                Server Name  Db / Schema  Table      Transformations  Outputs  Connections\n  ----                -----------  -----------  -----      ---------------  -------  -----------\n  billing_job         postgresql   public       customers  1                1        target\n  customers_hash_job  mysql        inventory    customers  0                1        target\n  orders_job          mysql        inventory    orders     1                1        target\n\nComponents:\n  Name                  Type                Version    Status   Metrics Endpoints\n  ----                  ----                -------    ------   -----------------\n  collector-api         collector-api       <version>  started\n  collector-mysql       debezium-collector  <version>  started  https://<rdi-host>:443/collector-mysql/metrics\n  collector-postgresql  debezium-collector  <version>  started  https://<rdi-host>:443/collector-postgresql/metrics\n  flink-processor       flink-processor     <version>  started  https://<rdi-host>:443/processor/metrics\n\nStatistics:\n  Name                         Incoming  Pending  Inserted  Updated  Deleted  Filtered  Rejected  Last Arrival\n  ----                         --------  -------  --------  -------  -------  --------  --------  ------------\n  mysql.inventory.customers    4         0        4         0        0        0         0         2026-06-18T13:42:44Z\n  mysql.inventory.orders       12        0        12        0        0        0         0         2026-06-18T13:42:51Z\n  postgresql.public.customers  7         0        7         0        0        0         0         2026-06-18T13:42:49Z",
      "section_id": "example"
    }
  ]
}