Skip to content

Commit

Permalink
doc: document source status paused (#31209)
Browse files Browse the repository at this point in the history 
Co-authored-by: kay-kim <[email protected]>
  • Loading branch information
@sjwiesman @kay-kim
sjwiesman and kay-kim authored Jan 27, 2025
1 parent 131d014 commit 5b5b37b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
15 changes: 7 additions & 8 deletions doc/user/content/ingest-data/troubleshooting.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ SELECT * FROM mz_internal.mz_source_statuses
WHERE name = <SOURCE_NAME>;
```

If your source reports a status of `stalled` or `failed`, you likely have a
configuration issue. The returned `error` field will provide more details.

If your source reports a status of `starting` for more than a few minutes,
[reach out to our team](http://materialize.com/convert-account/) for support.

If your source reports a status of `running`, but you are not receiving data
when you query the source, the source may still be ingesting its initial
snapshot. See [Has my source ingested its initial snapshot?](#has-my-source-ingested-its-initial-snapshot).
| Status | Description/recommendation |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `paused` | Source is running on a cluster with 0 replicas. To resolve this, [increase the replication factor](/sql/alter-cluster/#replication-factor-1) of the cluster. |
| `stalled` | You likely have a configuration issue. The returned `error` field will provide more details. |
| `failed` | You likely have a configuration issue. The returned `error` field will provide more details. |
| `starting` | If this status persists for more than a few minutes, [reach out to our team](http://materialize.com/convert-account/) for support. |
| `running` | If your source is in a `running` state but you are not receiving data when you query the source, the source may still be ingesting its initial snapshot. See [Has my source ingested its initial snapshot?](#has-my-source-ingested-its-initial-snapshot). |

## Has my source ingested its initial snapshot?

Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/sql/system-catalog/mz_internal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1150,7 +1150,7 @@ debugging.
| `name` | [`text`] | The name of the source. |
| `type` | [`text`] | The type of the source. |
| `last_status_change_at` | [`timestamp with time zone`] | Wall-clock timestamp of the source status change. |
| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `stalled`, `failed`, or `dropped`. |
| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`. |
| `error` | [`text`] | If the source is in an error state, the error message. |
| `details` | [`jsonb`] | Additional metadata provided by the source. In case of error, may contain a `hint` field with helpful suggestions. |

Expand All @@ -1165,7 +1165,7 @@ messages and additional metadata helpful for debugging.
| -------------- | ------------------------------- | -------- |
| `occurred_at` | [`timestamp with time zone`] | Wall-clock timestamp of the source status change. |
| `source_id` | [`text`] | The ID of the source. Corresponds to [`mz_catalog.mz_sources.id`](../mz_catalog#mz_sources). |
| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `stalled`, `failed`, or `dropped`. |
| `status` | [`text`] | The status of the source: one of `created`, `starting`, `running`, `paused`, `stalled`, `failed`, or `dropped`. |
| `error` | [`text`] | If the source is in an error state, the error message. |
| `details` | [`jsonb`] | Additional metadata provided by the source. In case of error, may contain a `hint` field with helpful suggestions. |

Expand Down

0 comments on commit 5b5b37b

Please sign in to comment.