Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.79 KB

productoncode.md

File metadata and controls

17 lines (12 loc) · 1.79 KB

Make your code production-ready



One Paragraph Explainer

Following is a list of development tips that greatly affect the production maintenance and stability:

  • The twelve-factor guide – Get familiar with the Twelve factors guide
  • Be stateless – Save no data locally on a specific web server (see separate bullet – ‘Be Stateless’)
  • Cache – Utilize cache heavily, yet never fail because of cache mismatch
  • Test memory – gauge memory usage and leaks as part your development flow, tools such as ‘memwatch’ can greatly facilitate this task
  • Name functions – Minimize the usage of anonymous functions (i.e. inline callbabk) as a typical memory profiler will provide memory usage per method name
  • Use CI tools – Use CI tool to detect failures before sending to production. For example, use ESLint to detect reference errors and undefined variables. Use –trace-sync-io to identify code that uses synchronous APIs (instead of the async version)
  • Log wisely – Include in each log statement contextual information, hopefully in JSON format so log aggregators tools such as Elastic can search upon those properties (see separate bullet – ‘Increase visibility using smart logs’). Also, include transaction-id that identifies each request and allows to correlate lines that describe the same transaction (see separate bullet – ‘Include Transaction-ID’)
  • Error management – Error handling is the Achilles’ heel of Node.JS production sites – many Node processes are crashing because of minor errors while others hang on alive in a faulty state instead of crashing. Setting your error handling strategy is absolutely critical, read here my error handling best practices