platform/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

Links

Open Source Insights

README ¶

Platform

Cross-domain packages shared by SubmitQueue, Stovepipe, and other services in this repository. Nothing under platform/ may depend on domain folders (submitqueue/, stovepipe/).

Packages

errs/ — Error classification (errs types, classifiers, MySQL/generic helpers).
metrics/ — Tally helpers with error-aware tagging via platform/errs.
consumer/ — Queue consumer framework (consumer.Controller, registry, DLQ wiring).
http/ — Small HTTP client helpers (e.g. base-URL RoundTripper). Go import path: github.com/uber/submitqueue/platform/http; package name is http. Callers that also import net/http should import this package with an alias (for example phttp "github.com/uber/submitqueue/platform/http") and use phttp.NewClient.
base/ — Shared domain entities (change, messagequeue, and related subpackages). Root package base is documentation-only.
extension/ — Shared extension interfaces and implementations reused across domains (counter, messagequeue, and backends such as mysql).

Domain-scoped infrastructure and extensions stay under each domain (for example submitqueue/core/, submitqueue/extension/).

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
base Package base is the root of shared domain entities used across SubmitQueue, Stovepipe, and other repo-local services.	Package base is the root of shared domain entities used across SubmitQueue, Stovepipe, and other repo-local services.
change Package change holds the shared code-change identity used across SubmitQueue, Stovepipe, and other repo-local domains.	Package change holds the shared code-change identity used across SubmitQueue, Stovepipe, and other repo-local domains.
change/changeutil Package changeutil holds small helpers shared across the entity/change provider subpackages (github, git, ...).	Package changeutil holds small helpers shared across the entity/change provider subpackages (github, git, ...).
change/git Package git parses change IDs that use the git:// URI scheme.	Package git parses change IDs that use the git:// URI scheme.
change/github
change/phabricator
mergestrategy Package mergestrategy holds the shared source-control integration strategy used across SubmitQueue, runway, and other repo-local domains.	Package mergestrategy holds the shared source-control integration strategy used across SubmitQueue, runway, and other repo-local domains.
messagequeue
page Package page defines a generic, cursor-paginated result envelope shared across domains.	Package page defines a generic, cursor-paginated result envelope shared across domains.
consumer
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
errs
generic Package generic provides an errs.Classifier for errors that are not tied to any particular backend.	Package generic provides an errs.Classifier for errors that are not tied to any particular backend.
mysql Package mysql provides an errs.Classifier for errors originating from the go-sql-driver/mysql driver and the standard database/sql + net packages commonly seen when talking to a MySQL backend.	Package mysql provides an errs.Classifier for errors originating from the go-sql-driver/mysql driver and the standard database/sql + net packages commonly seen when talking to a MySQL backend.
extension Package extension holds extension interfaces and implementations shared across SubmitQueue, Stovepipe, and other repo-local services.	Package extension holds extension interfaces and implementations shared across SubmitQueue, Stovepipe, and other repo-local services.
consumergate Package consumergate defines the consumer-gate extension: runtime stop/start of individual queue controllers without stopping the service that hosts them.	Package consumergate defines the consumer-gate extension: runtime stop/start of individual queue controllers without stopping the service that hosts them.
consumergate/file Package file implements the consumergate contract with plain files in a shared directory.	Package file implements the consumergate contract with plain files in a shared directory.
consumergate/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
consumergate/noop Package noop provides a no-op consumergate.Gate that admits every delivery immediately.	Package noop provides a no-op consumergate.Gate that admits every delivery immediately.
counter
counter/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
counter/mysql
messagequeue
messagequeue/mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.
messagequeue/mysql Package mysql is a generated GoMock package.	Package mysql is a generated GoMock package.
messagequeue/mysql/ctl command
messagequeue/mysql/ctl/lib
http Package http provides shared HTTP client helpers (e.g.	Package http provides shared HTTP client helpers (e.g.
lifecycle Package lifecycle provides the Component interface and Group type for managing ordered start/stop lifecycles.	Package lifecycle provides the Component interface and Group type for managing ordered start/stop lifecycles.
metrics
pipeline Package pipeline provides a typed engine for assembling queue-driven service pipelines from declarative data.	Package pipeline provides a typed engine for assembling queue-driven service pipelines from declarative data.