{
  "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/2.0.0/reference/cli/redis-di-describe/",
  "summary": "Describes a pipeline with its status",
  "content": "\nDescribes 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.\n\n## Usage\n\n```\nredis-di describe [pipeline] [flags]\n```\n\nThe pipeline name is an optional argument that defaults to `default`.\n\n## Options\n\nThis command takes only the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di#global-options).\n\n## Example\n\n```bash\nredis-di describe\nredis-di status my-pipeline\n```\n\nTo watch the status update live, pair the command with `watch`:\n\n```bash\nwatch -n 1 redis-di describe\n```\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```\nName:     default\nActive:   yes\nStatus:   started\nCurrent:  yes\n\nSources:\n  Name        Type  Db Type     Connection              Sync Mode  Connected\n  ----        ----  -------     ----------              ---------  ---------\n  mysql       cdc   mysql       \u003cmysql-host\u003e:3306       streaming  yes\n  postgresql  cdc   postgresql  \u003cpostgresql-host\u003e:5432  streaming  yes\n\nTargets:\n  Name    Db Type  Connection                 Connected\n  ----    -------  ----------                 ---------\n  target  redis    \u003credis-target-host\u003e: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       \u003cversion\u003e  started\n  collector-mysql       debezium-collector  \u003cversion\u003e  started  https://\u003crdi-host\u003e:443/collector-mysql/metrics\n  collector-postgresql  debezium-collector  \u003cversion\u003e  started  https://\u003crdi-host\u003e:443/collector-postgresql/metrics\n  flink-processor       flink-processor     \u003cversion\u003e  started  https://\u003crdi-host\u003e: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\n```\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.\n",
  "tags": ["redis-di"],
  "last_updated": "2026-10-30T16:31:14Z"
}