dazn-lambda-powertools icon indicating copy to clipboard operation
dazn-lambda-powertools copied to clipboard

Standardise powertools specific environment variables with a prefix

Open gsingh1 opened this issue 6 years ago • 1 comments

This is a Feature Proposal

Description

Currently, the environment variable names that are used throughout the project feel too generic and could be prone to naming collisions.

Existing powertools environment variables:

  • SAMPLE_DEBUG_LOG_RATE
  • LOG_LEVEL
  • DATADOG_TAGS - This may be out of scope for this proposal

The proposal is for a future major release that all environment variables (exisiting and new) that are powertools specific are to be prefixed. This would prevent any chance of collisions.

In addition, the usage of the the environment variables with set prefixes will allow simple identification and association to the powertools package.

Prefix ideas:

  • DAZNPOWERTOOLS_
  • POWERTOOLS_
  • DAZNLP_
  • DAZN_
  • PWRTLS_

This will be a breaking change but one that would benefit the project in the long term especially now that the project is open-sourced.

gsingh1 avatar Jun 21 '19 10:06 gsingh1

POWERTOOLS_ looks good enough to me because the packages prefix is lambda-powertools- and using lambda as prefix (as in LAMBDA_POWERTOOLS_) might be redundant.

rmax avatar Oct 17 '19 20:10 rmax