Skip to content

feat(connectors): add sink/source connector templates, authoring guide, and blog post #4636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryerraguntla wants to merge 6 commits into
base: master
Choose a base branch
from
+3,322 −204
Open

feat(connectors): add sink/source connector templates, authoring guide, and blog post #4636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4937548
Initial version of connectors template
ryerraguntla Oct 10, 2026
0c338c5
Fixed couple of trivial issues
ryerraguntla Oct 11, 2026
28b1f9b
feat(connectors): add sink/source templates, authoring guide, blog post
ryerraguntla Oct 22, 2026
62db17a
Merge branch 'docs/connector-guidelines-template-and-blog-post' of ss…
ryerraguntla Oct 22, 2026
b51e55e
Adding connector related skills
ryerraguntla Oct 24, 2026
e349759
Adding connector pr review agent skills
ryerraguntla Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .agents/skills/connector-pr-review
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../.claude/skills/connector-pr-review
385 changes: 385 additions & 0 deletions .claude/skills/connector-pr-review/SKILL.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions .claude/skills/connector-runtime/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Fatal errors propagate to `main` and exit. Per-connector / per-message errors ar

All families labeled by `connector_key` + `connector_type` (histogram adds `stage`):

- **Counters**: `iggy_connector_messages_{produced,sent,consumed,processed,filtered}_total` and `iggy_connector_errors_total`. These are the *rendered* names; each is registered without the `_total`, which the OpenMetrics encoder appends.
- **Counters**: `iggy_connector_messages_{produced,sent,consumed,processed,filtered,errors}_total`.
- `messages_filtered_total` - intentional drops via transform `Ok(None)`.
- `errors_total` - unexpected drops (decode/encode/build failure, missing field, ...) + batch-level failures, one per failed run.
- `sink_runs_total` - FFI `consume()` calls for sink batches, one per contiguous payload-variant run. Divide by `stage_duration_seconds_count{stage="total"}` for runs per batch.
Expand All @@ -224,7 +224,7 @@ All families labeled by `connector_key` + `connector_type` (histogram adds `stag

When adding a metric:

- Add family to `Metrics` struct + `init`, register with name + help text. Never end a `Counter` family's registered name in `_total`: the encoder appends it and the series renders `_total_total`. Gauges get no suffix, so a gauge name may end in `_total` literally.
- Add family to `Metrics` struct + `init`, register with name + help text.
- New label sets define `EncodeLabelSet` struct + label enum (hand-impl `EncodeLabelValue` for snake_case values - the derive emits PascalCase).
- Histograms: pass `fn() -> Histogram` to `Family::new_with_constructor`.
- Add unit tests under `mod tests` with `given_*_when_*_should_*` BDD names.
Expand Down
3 changes: 2 additions & 1 deletion .claude/skills/connector-sink/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ for getting them to the external system reliably and efficiently.

## Quick reference

- Skeleton: [TEMPLATE.md](TEMPLATE.md) (load on demand when authoring).
- Skeleton: [TEMPLATE.md](TEMPLATE.md) (fill-in-the-blank kit — implement only `TODO(ConnectorDeveloper)`).
- PR pre-flight: [connector-pr-review](../connector-pr-review/SKILL.md).
- Exemplars: `stdout_sink` (minimal), `postgres_sink` (DB + transient detection), `http_sink` (validation, batch modes, retry middleware), `mongodb_sink` (atomic counters), `elasticsearch_sink` / `iceberg_sink` (backend-specific idioms).

## Hard rules
Expand Down
Loading
Loading