notexOPENOverview
Notex/Systems/Maintainability

Maintainability

Always free to read

▷LESSON VIDEOOverview: MaintainabilityVideo coming soon. Start with the reading below.COMING SOON

References

Testing
  1. Cindy Sridharan wrote a great blog post series on the topic, see “Testing Microservices, the sane way,” https://copyconstruct.medium.com/testing-microservices-the-sane-way-9bb31d158c16
  2. The kind of unit test I have in mind is the sociable kind; see “On the Diverse And Fantastical Shapes of Testing,” https://martinfowler.com/articles/2021-test-shapes.html
  3. “IntegrationTest,” https://martinfowler.com/bliki/IntegrationTest.html
  4. “Software Engineering at Google: Lessons Learned from Programming Over Time,” https://www.amazon.com/dp/B0859PF5HB
  5. “ContractTest,” https://martinfowler.com/bliki/ContractTest.html
  6. “The TLA+ Home Page,” https://lamport.azurewebsites.net/tla/tla.html
  7. TLA stands for Temporal Logic of Actions.
  8. “Industrial Use of TLA+,” https://lamport.azurewebsites.net/tla/industrial-use.html
Continuous delivery and deployment
  1. There could be multiple breaking changes, actually.
  2. “What is Infrastructure as Code?,” https://docs.microsoft.com/en-us/devops/deliver/what-is-infrastructure-as-code
  3. “Terraform: an open-source infrastructure as code software tool,” https://www.terraform.io/
  4. “Automating safe, hands-off deployments,” https://aws.amazon.com/builders-library/automating-safe-hands-off-deployments/
  5. This is also referred to as canary testing.
  6. CD pipelines can be configured to run only during business hours to minimize the disruption to on-call engineers.
  7. “Ensuring rollback safety during deployments,” https://aws.amazon.com/builders-library/ensuring-rollback-safety-during-deployments/
Monitoring
  1. “Measure Anything, Measure Everything,” https://codeascraft.com/2011/02/15/measure-anything-measure-everything/
  2. “Using synthetic monitoring,” https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html
  3. I have omitted error handling for simplicity.
  4. We will talk more about event logs in Logs in Observability; for now, assume an event is just a dictionary.
  5. “Log-based metrics in Application Insights,” https://docs.microsoft.com/en-us/azure/azure-monitor/app/pre-aggregated-metrics-log-metrics#log-based-metrics
  6. “Amazon CloudWatch concepts,” https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html
  7. like, e.g., Druid; see “A Real-time Analytical Data Store,” http://static.druid.io/docs/druid.pdf
  8. “latency: a primer,” https://igor.io/latency/
  9. “Akamai Online Retail Performance Report: Milliseconds Are Critical,” https://www.akamai.com/newsroom/press-release/akamai-releases-spring-2017-state-of-online-retail-performance-report
  10. Little’s law says the average number of items in a system equals the average rate at which new items arrive multiplied by the average time an item spends in the system; see “Back of the envelope estimation hacks,” https://robertovitillo.com/back-of-the-envelope-estimation-hacks/
  11. “Service Level Objectives,” https://sre.google/sre-book/service-level-objectives/
  12. “Chaos engineering,” https://en.wikipedia.org/wiki/Chaos_engineering
  13. “Alerting on SLOs,” https://sre.google/workbook/alerting-on-slos/
  14. “Building dashboards for operational visibility,” https://aws.amazon.com/builders-library/building-dashboards-for-operational-visibility
  15. Ideally, we should automate what we can to minimize manual actions that operators need to perform. As it turns out, machines are good at following instructions.
  16. “SRE Books,” https://sre.google/books/
Observability
  1. Azure Data Explorer is one such event store, see “Azure Data Explorer: a big data analytics cloud platform optimized for interactive, adhoc queries over structured, semi-structured and unstructured data,” https://azure.microsoft.com/mediahandler/files/resourcefiles/azure-data-explorer/Azure_Data_Explorer_white_paper.pdf
  2. “What is the ELK Stack?,” https://www.elastic.co/what-is/elk-stack
  3. “Dynamic Sampling by Example,” https://www.honeycomb.io/blog/dynamic-sampling-by-example/
  4. “Zipkin: a distributed tracing system,” https://zipkin.io/
  5. “AWS X-Ray,” https://aws.amazon.com/xray/
  6. The service mesh pattern can help retrofit tracing.
Manageability
  1. “Continuous Configuration at the Speed of Sound,” https://www.allthingsdistributed.com/2021/08/continuous-configuration-on-aws.html
  2. “AWS AppConfig Documentation,” https://docs.aws.amazon.com/appconfig/
  3. “Azure App Configuration,” https://azure.microsoft.com/en-us/services/app-configuration/
  4. “A/B testing,” https://en.wikipedia.org/wiki/A/B_testing
Final words
  1. “Windows Azure Storage: A Highly Available Cloud Storage Service with Strong Consistency,” https://sigops.org/s/conferences/sosp/2011/current/2011-Cascais/printable/11-calder.pdf
  2. “Azure Data Explorer: a big data analytics cloud platform optimized for interactive, ad-hoc queries over structured, semi-structured and unstructured data,” https://azure.microsoft.com/mediahandler/files/resourcefiles/azure-data-explorer/Azure_Data_Explorer_white_paper.pdf
  3. If you are new to reading papers, use the three-pass approach by S. Keshav, see “How to Read a Paper,” https://web.stanford.edu/class/ee384m/Handouts/HowtoReadPaper.pdf
KEEP EXPLORING

One note leads to another.

Back to the library →
⌕
Search across the entire library ⌘ K