Design patterns and Code conventions

Cortex adopts some design patterns and code conventions that we ask you to follow when contributing to the project. These conventions have been adopted based on the experience gained over the time and aim to enforce good coding practices and keep a consistent UX (ie. config).

Go coding style

Cortex follows the Go Code Review Comments styleguide and the Formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments.

No global variables

• Do not use global variables

Prometheus metrics

When registering a metric:

• Do not use a global variable for the metric
• Create and register the metric with promauto.With(reg)
• In any internal Cortex component, do not register the metric to the default prometheus registerer, but pick the registerer in input (ie. NewComponent(reg prometheus.Registerer))

Testing metrics:

• When writing using tests, test exported metrics using testutil.GatherAndCompare()

Config file and CLI flags conventions

Naming:

• Config file options should be lowercase with words _ (underscore) separated (ie. memcached_client)
• CLI flags should be lowercase with words - (dash) separated (ie. memcached-client)
• When adding a new config option, look if a similar one already exists within the config and keep the same naming (ie. addresses for a list of network endpoints)

Documentation:

• A CLI flag mentioned in the documentation or changelog should be always prefixed with a single - (dash)