Skip to main content
Version: 2.0.0 (Latest)

Naming Conventions

Configuration keys in padas.toml / padas.default.toml use snake_case; prefer explicit units in names (*_ms, *_bytes, *_secs). The same idea applies across TOML and JSON bodies where Core exposes REST APIs.

Use this pattern for registry-managed object names (connectors, tasks, pipelines, rules, and cores):

<scope>-<kind>-<tech>-<purpose>[-<env>[-<seq>]]

  • Scopestream, conn, task, pipe, query, rule, core
  • Kindsource or sink (for connectors)
  • Techhttp, kafka, syslog, file, s3
  • Purpose — workload intent such as quickstart, fortigate, alerts, raw
  • Env / Seq — optional suffixes such as dev, stg, prod, 01, 02

Examples:

  • conn-source-http-quickstart
  • conn-sink-http-quickstart
  • task-quickstart-normalize
  • query-quickstart-normalize
  • pipe-quickstart-main

When stream auto-generation is enabled from connector names, generated stream IDs are typically:

  • conn-source-http-quickstart_stream
  • conn-sink-http-quickstart_stream