Example patterns for distributed service

Cloud Native

Tulisan ini akan mengulas hasil pembelajaran dari beberapa sumber #learn-from-books. Dan terinspirasi dari obrolan The Pursuit of Production-Ready Software: Best Practices and Principles untuk mengulik lebih jauh.

Semua pembahasan tersebut mengerucut ke system Dependability. Konsep Dependability pertamakali didefinisikan oleh Jean-Claude Laprie sekitar 35 tahun yang lalu. Jadi ini bukanlah konsep yang baru.

Mengutip dari gambar di wikipedia. Komponen dependability seperti ini:

  • Dependability:
    • Attributes
      • Availability
      • Reliability
      • Maintainability
      • Safety
      • Confidentiality
      • Integrity
    • Threats
      • Faults
      • Errors
      • Failures
    • Means
      • Prevention
      • Tolerance
      • Removal
      • Forecasting
  • Availability

    Kemampuan system berkerja dalam suatu waktu secara acak. Biasanya diekspresikan dari berapa banyak request yang diterima oleh system. Uptime dibagi dengan total time.

  • Reliability

    Kemampuan system berkerja dalam interval waktu. Biasanya diekspresikan dengan mean time beetwen failures (MTBF: total time dibagi denan total failures) atau failure rate (number or failures dibagi total time).

  • Maintainability

    Kemampuan suatu sistem untuk mengalami modifikasi dan perbaikan. Ada beberapa jenis untuk mengukur maintainability. Mulai dari perhitungan cyclomatic complexity hingga pelacakan total waktu yang diperlukan untuk melakukan perbaikan system atau mengembalikan ke status sebelumnya.

Ada 4 kategori teknik yang dapat digunakan untuk mengimprove systems depentability:

  • Fault prevention (Scalability / Loose Coupling)

    Digunakan selama pembuatan system untuk mencegah terjadinya kesalahan.

  • Fault tolerance (Resilence / Loose Coupling)

    Digunakan selama mendesign system dan implementasi untuk mencegah kegagalan karena adanya kesalahan.

  • Fault removal (Manageability)

    Digunakan untuk mengurangi jumlah dan tingkat keparahan(severity) kesalahan.

  • Fault forecasting (Observability)

    Digunakan untuk menidentifikasi keberadaan, penciptaan dan kosekuensi dari kesalahan.

Fault Prevention

Fault Prevention menjadi dasar dari semuanya. Kenapa? karena disini adalah tahap pembuatan system. Lalu apa saja yang harus dilakukan:

  • Good Programming Practice
    • Pair Programming
    • Test-Driven Development
    • Code Review Practice
  • Language features Pemilihan bahasa cukup berpengaruh. Setiap bahasa punya paradigma dan karakteristik masing masing. Bisa baca dibuku Clean Architechture - PARADIGM OVERVIEW
  • Scalability Kemampuan dari suatu sistem untuk terus memberikan layanan dalam menghadapai perubahan sesuai dengan permintaan.
  • Loose Couplling Artinya setiap sistem saling terhubung tetapi atar service hanya tau interfacenya saja.

Fault Tolrerance

Setelah Fault Prevention, maka masuk ke Fault Tolerance.

Ada beberapa nama lain seperti self-repair, self-healing, resillience. Semuanya menggamarkan kemampuan sistem untuk mendeteksi kesalahan dan mencegah menjadi kesalahan yang lebih besar. Biasanya terdiri dari 2 bagian, error detection dan recovery

Fault Removal

Selanjutnya adalah Fault Removal adakag proses mengurangi jumlah dan tingkat keparahan (severity) kesalahan. Bahkan dikondisi ideal pun ada banyak cara yang membuat sistem melakukan kesalahan atau berperilaku tidak semestinya. Mungkin gagal melakuka tindakan yang diharapkan atau melakukan tindakan yang salah.

Banyak kesalahan bisa diindentifikasi melalui testing yang memungkinkan untuk kita menverifikasi sistem yang kita buat.

Verification and Testing

Cuma ada satu cara buat menemukan kesalahan pada software. yaitu testing. Kalau bukan kita yang nemuin ya user yang menggunakan sistem kita yang mengerikan jika usernya jahat. Bisa berbahaya jika dia mengambil keuntungan dari kesalahan tersebut.

Ada 2 pendekatan:

  1. Static Analisis Berguna untuk memberikan feedback diawal, memaksa untuk melakukan praktek yang konsisten dan menemukan error yang umum. Tanpa perlu bantuan manusia. Biasanya bisa menggunakan tools seperti , codeclimate, dll
  2. Dynamic Analisis Kalau ini testing yang memerlukan manusia.

Kunci dari software testing adalah membuat software yang designed for testability. function yang teatabilitynya tinggi adalah function yang memiliki tujuan tunggal dengan input dan output yang terdefinisi dengan baik atau sedikit efek samping.

Manageability

Kesalahan pada sistem ada karena sistem tidak berkerja sesuai requirement. Dengan Designing for manageability mengizinkan perilaku system diubah tanpa ada perubahan dicode. Manageable system pada dasarnya seperti sistem yang memiliki knob yang memungkinkan kontrol secara real-time untuk menjaga sistem kita tetap aman, bejalan lancar dan sesuai dengan requirement. Misalnya seperti feature flags yang bisa menyalakan atau mematikan fitur atau loading plug-in yang mengubah perilaku.

Fault Forecasting

Ini adalah tahap terakhir, tahap ini dibangun berdasarkan pengetahuan dari kejadian yang ada dan kumpulan dari solusi solusi yang diterapkan. Biasanya cuma menebak nebak saja. Tapi dengan membuat system design for observability indikator kesalahan bisa ditrack jadi kita bisa memprediksi dengan tepat sebelum berubah menjadi error.

Twelve-Factor App

Jadi sekitar tahun 2010an, para developer dari heroku menyadari sesuatu karena seringnya mereka melihat development web memiliki masalah yang sama. Lalu mereka menyusun The Twelve-Factor App, ini adalah kumpulan aturan main dan panduan yang merupakan metedologi pengembangan web. Metedologinya sebagai berikut:

  • Gunakan deklaratif format untuk setup automation, guna membantu developer baru yang join project.
  • Memiliki clean contract pada sistem operasi yang digunakan.
  • Cocok digunakan pada cloud platform modern sehingga tidak memerlukan server dan sysadmin.
  • Meminimalisir perbedaan antara environment development dan production.
  • Dapat scale up tanpa perubahan yang signifikan pada tools, architechture atau development practice.

Jadi apa saja isi dari cloud native:

  1. Codebase

    One codebase tracked in revision control, many deploys.

    Satu codebase untuk segala environtment, biasanya development, staging dan production.

  2. Dependencies

    Explicitly declare and isolate (code) dependencies.

    TODO: penjelasan

  3. Configuration

    Store configuration in the environment.

    Konfigurasi untuk setiap environment haruslah terpisah dari code, Jangan sampai ada konfigurasi yang dimasukan kedalam code. Contoh konfigurasi yang tidak boleh dimasukan kedalam code.

    • URL/DSN database atau apapun yang menjadi dependensi ke service kita.
    • Segala jenis secret, seperti password atau credential external service.
    • environment value, seperti hotname untuk deploy.

    Umumnya konfigurasi diletakan diYAML file dan tidak dimasukan kedalam repository. Tapi ini kurang ideal. Kenapa? Pertama, bisa jadi tidak sengaja masuk kedalam repository. Lalu, bisa terjadi miskonfigurasi karena lupa melakukan perubahan diproduction.

    Jadi, daripada membuat konfigurasi sebagai code atau sebagai konfigurasi external. The Twelve-Factor App merekomendasikan agar konfigurasi diletakan sebagai environment variables.

    Keuntungan menggunakan environment variables: - Menjadi standard disemua OS dan language agnostic - Mudah dideploy tanpa melakukan perubahan disisi code - Mudah untuk diinject kedalam container

  4. Backing Services

    Treat backing services as attached resources.

    Backing service seperti datastore, messaging system, SMTP, dll harus diperlakukan sebagai seuatu yang mudah digantikan. Jadi perubahan disetiap environment hanya perlu ubah disisi environment variables.

  5. Build, Release, Run

    Strictly separate build and run stages.

    Pada saat deployment, biasanya ada tiga tahap terpisah.

    • Build Tahap ini biasanya proses automate dalam mengambil code dari spesifik versi, mengambil dependensi dan mencompile menjadi executeable artifact. Setiap build biasanya dilengkapi dengan identifier yang unik seperti timestamp atau urutan angka build.
    • Release Ditahap ini, setelah code dibuild lalu dimasukan konfigurasi yang menuju ke spesifik target deployment(develeopment, staging, production)
    • Run Tahap ini, proses menjalankan ke target.
  6. Processes

    Execute the app as one or more stateless processes.

    Service harus stateless dan tidak membagi apapun, data harus disimpan di datastore bukan diaplikasi.

  7. Data Isolation

    Each service manages its own data.

    Setiap service seharusnya memiliki data sendiri dan data hanya bisa diakses melalu API yang sudah didesign.

  8. Scalability

    Scale out via the process model.

    Sistem dapat dianggap "scalable" jika kita bisa menambah atau mengurangi kekuatan service sesuai kebutuhan dengan mudah.

    Scaling ada 2 bentuk, yaitu:

     - Vertical Scaling (scale up)
    
         Menambah resource server / phisical resource. Dijaman cloud computing saat ini sudah cukup mudah untuk menambah resource.
    
     - Horizontal Scaling
    
         Menduplikasi system atau service untuk membatasi beban disatu server. 
         Tapi aplikasi kita haruslah `stateless` karena akan sulit mekalukan scaling jika `state`.
    

    Apa yang menyebabkan system harus discale?

    Penyebabnya biasanya karena adanya kemacetan "Bottleneck". Solusi gampangnya ya menaikan resource komponen yang bottleneck (Vertical Scaling). Tapi cara ini gak akan bisa digunakan selamanya, Resource yang dinaikan pasti ada batasnya seperti batas teknologi dan batas keuangan. Makin tinggi resource yang digunakan pastinya akan semakin mahal.

    Biasanya apa saja yang komponen-komponen yang bisa bottleneck?

    • CPU
    • Memory
    • Disk I/O
    • Network I/O

    Apa itu stateful dan stateless?

    Stateful itu aplikasi yang service dan datanya disimpan didalam satu container atau lokal. Aplikasi seperti ini sulit untuk direplica karena datanya juga pasti akan tereplika menjadi 2 sistem berbeda.

    Stateless sebaliknya, sevice dan data terpisah. Sehingga kita bisa menduplikasi service dengan mudah, karena data terpusat diluar dari service aplikasi.

    Keuntungan membuat aplikasi stateless:

    • Scalability

      System akan lebih mudah untuk ditambah atau dikurangi. Karena tidak ada data yang tersimpan didalam service. Semua data sudah terpusat ditempat lain.

    • Durability

      Karena data sudah terpusat ditempat lain, kita tidak akan kehilangan data ketika service ditambah atau dikurangi.

    • Simplicity

      Tidak perlu ada data yang disync, bisa dengan cepat mereplika system

    • Cacheability

      APIs yang didesign dengan stateless service relatif mudah untuk dicache.

    Selain itu untuk mencapai sistem yang skalable, kita perlu belajar tentang service architechture.

    Dalam pengembangan sistem biasanya dimulai dengan The Monolith System Architecture. Dimana satu service menjalankan banyak proses secara bersamaan. Banyak fungsi-fungsi didalamnya digabungkan dalam 1 database. Pada prosesnya monolith system lebih sederhana membuatnya tapi seiring berjalannya waktu akan sulit untuk dimanage dan discale.

    Setelah monolith biasanya system akan berkembang ke The Microservices System Architecture. Dimana system akan dipecah pecah sesuai dengan domainnya. Ada pendapat dari Martin Fowler harus monolith first. Alasannya masuk akal, "Kalau kita gak bisa bikin system monolith yang benar, bagaimana cara kita bikin microservice". Tapi yang menarik ada bantahan dari Stevan Tilkov - Don't Start with Monolith. Keduanya menarik untuk dipelajari.

    Lalu muncul perkembangan lagi yang perlu kita pelajari, yaitu Serverless Architecture. Mulai ramai setelah kemunculan AWS Lambda lalu dikuti cloud provider lain seperti GPC Cloud Function yang berlomba-lomba dalam membuat serverless provder.

    Serverless bukannya tanpa server, tetap ada server tapi kita tidak perlu repot-repot mengkonfigurasi disisi server. Kalau microservice kita perlu memcah system sesuai domain dengan cara serverless kita bisa pecah hingga level function. Karena itu dikenal dengan FaasS (Function as a Service).

    Diluar dari cloud provider ada juga beberapa project open source yang memungkinkan kita membuat serverless sendiri, seperti Knative, OpenFaas, Kubeless, dll

    Kelebihan dan Kekurangan menggunakan Serverless Architechture:

    • Kelebihan

      • Operational Management
      • Scalability
      • Reduce Cost
      • Productivity
    • Kekurangan

      • Vendor Lock-In

        Kalau pakai AWS Lambda atau Cloud Function. Kalo pakai knative, openfass, dll mestinya gak vendor lock-in tapi tetap ada configurasi diawal.

      • Startup latency

        Atau istilah lainnya cold start, karena biasanya kita akan sering mematikan dan menyalakan. Ketika service tidak dihit, maka server akan idle dan tidak ada resource yang perlu dibayar. Tapi buruknya akan ada jeda ketika server mulai berkerja lagi.

      • Tidak cocok untuk task yang lama.

        Serverless diperuntukan menjalankan process yang cepat, hit, process, stop. Kalo dipaksa untuk menjalankan process yang lama bisa saja, tapi hitungannya menjadi lebih mahal.

      • Complexity

        Karena biasanya bentuknya function, jika tidak didokumentasikan dengan baik akan susah sendiri nantinya. Karena akan lebih banyak function yang dideploy dan tidak terdokumentasi.

      Sumber Belajar Lain:

  9. Disposability

    Maximize robustness with fast startup and graceful shutdown.

    • Service harus meminimalkan waktu untuk start up
    • Service harus bisa shutting down ketika menerima sinya SIGTERM. Stop request yang masuk, Selesaikan semua proses dan tutup semua koneksi.

    Baca juga, belajar gracefull shutdown.

  10. Development/Production Parity

    Keep development, staging, and production as similar as possible.

    Perbedaan antara development dan production harus semirip mungkin.

    • Code divergence Branch development harus kecil dan short-lived, harus segera ditest dan dideploy ke production ASAP.
    • Stack divergence Stack yang digunakan untuk menjalankan service harus sama mulai dari jenis os, versi os, jenis datastore dan versinya, dll
    • Personnel divergence Libatkan pembuat code dalam proses deployment
  11. Logs

    Treat logs as event streams.

    TODO: penjelasan

  12. Administrative Processes

    Run administrative/management tasks as one-off processes.

    TODO: penjelasan

Learn From Books:

Common Failure

Asumsi-asumsi yang salah dalam distributed computing, menurut L Peter Deutsch,

  • The network is reliable: switches fail, routers get misconfigured
  • Latency is zero: it takes time to move data across a network
  • Bandwidth is infinite: a network can only handle so much data at a time
  • The network is secure: don’t share secrets in plain text; encrypt everything
  • Topology doesn’t change: servers and services come and go
  • There is one administrator: multiple admins lead to heterogeneous solutions
  • Transport cost is zero: moving data around costs time and money
  • The network is homogeneous: every network is (sometimes very) different
  • Services are reliable: services that you depend on can fail at any time

Maka dari itu kita perlu belajar tentang stability pattern yang bisa digunakan.

  • Stability Pattern
    • Circuit Breaker
    • Retry
    • Debounce & Throttle
    • Timeout

Sebenarnya beberapa hal diatas bisa tercover dengan tools-tools seperti istio, nginx, dll. Tidak ada salahnya coba membuat dari sisi script jika tidak menggunakan tools tersebut.

Stability Pattern

Circuit Breaker

Circuit Breaker (CB), secara otomatis akan memutus jika terjadi kesalahan secara terus menerus. Untuk mencegah terjadinya kegagalan yang lebih besar dan lebih banyak. CB digunakan untuk menangkap error dan jika sudah mencapai batasnya akan open circuit atau memtutus request karena terlalu banyak error. CB terinspirasi dari kelistrikan, setiap instalasi listrik biasanya dipasang circuit breaker, Ketika terjadi konsleting, circute akan terbuka dan mematikan aliran listrik kerumah.

Sekarang bayangkan jika itu didalam system, Service yang kita buat akan mengquery ke database, lalu databasenya mati atau gagal meresponse. Jika terjadi cukup lama service kita akan dibanjiri dengan logs error yang sebetulnya tidak berguna. Ada baiknya jika kita stop saja semua request dari awal hingga database kembali berkerja.

CB pada dasarnya hanyalah function yang berupa Adapter Pattern diantara request dan response ke service lain. Function Breaker akan membungkus Function Circuit untuk menambahkan error handling. Function Breaker memiliki status open dan close. Jika status close maka function akan berjalan secara normal dengan meneruskan request yang diterima. Sebaliknya jika status open maka function tidak akan meneruskan dan membuat service gagal lebih cepat.

Dan biasanya akan ada logic auto close breaker, Untuk mengecek apakah service sudah berjalan dengan normal.

Untuk implementasi bisa dilihat Breaker.

Beberapa repository dan implementasi circuit breaker:

Reference

Retry

Retry adalah mekanisme pengulangan request ketika terjadi kegagalan ketika membuat request. Biasanya retry juga memiliki batas mengulang dan juga periode pengulangannya.

Sama seperti CB, untuk membuat Retry juga menggunakan Adapter Pattern. Function Retry akan membungkus Requestor, untuk mengandle error dari requestor. Lalu function Retry bisa mengkontrol berapa kali retry hingga akhirnya gagal dan juga delay setiap requestnya.

Untuk implementasi bisa dilihat Retry.

Beberapa repository dan implementasi retry:

Reference

Debounce && Throttle

Kedua pattern ini kurang lebih sama, hanya saja cara kerjanya berbeda.

Throttle menjaga input masuk dalam durasi tertentu, misalnya 100 request per menit. Debounce hanya menerima input yang sama dalam 1 kali,hanya diawal atau diakhir.

Throttle

Throttle membatasi jumlah function direquest. Contoh penggunaan:

  • User hanya boleh request dalam 10 kali per detik.
  • Membatasi jeda klik per 500 millisecond
  • Hanya boleh 3 kali gagal login dalam 24 jam

Tapi biasanya kita menggunakan Throttle memperhitungkan lonjakan aktifitas yang dapat memenuhi system. Jika system tidak sanggup, maka akan terjadi kegagalan.

Debounce

Debounce membatasi jumlah function direquest. Contoh penggunaan:

  • User hanya boleh request dalam 10 kali per detik.
  • Membatasi jeda klik per 500 millisecond
  • Hanya boleh 3 kali gagal login dalam 24 jam

Tapi biasanya kita menggunakan Throttle memperhitungkan lonjakan aktifitas yang dapat memenuhi system. Jika system tidak sanggup, maka akan terjadi kegagalan.

Timeout

Pada dasarnya timeout akan menghentikan proses dalam durasi waktu. Biasanya ketika ada masalah didalam service seperti query lambat atau konek ke service lain lambat. Sehingga proses berjalan menjadi lama. Agar tidak dalam proses terus menerus dan client mengunggu lama ada bagusnya kita kasih durasi akses. Bukan berarti proses lama itu pasti gagal, bisa jadi memang prosesnya perlu waktu sehingga harus dihandle secara asyc, bisa dibaca di long process API untuk melihat proof of concept dari handle api yang memproses lama.

Untuk membuat timeout pada service kita hanya perlu memainkan context

ctx := context.Background()
ctxt, cancel := context.WithTimeout(ctx, 10 * time.Second)
defer cancel()

result, err := SomeFunction(ctxt)
Similar Resources

Okta Golang Gin & Okta-Hosted Login Page Example

Okta Golang Gin & Okta-Hosted Login Page Example This example shows you how to use the Okta JWT verifier library to login a user to a Golang Gin appli

Oct 31, 2022

Colonies is a generic framework for implementing next-generation distributed applications and systems

Colonies is a generic framework for implementing next-generation distributed applications and systems

Colonies is a generic framework for implementing next-generation distributed applications and systems. It can be used as a building block for grid computing or edge computing, e.g. implement a meta operating system or cloud-of-cloud platform that combines many execution environments into a new virtual computing environment that can be controlled using an single unified API.

Nov 14, 2022

A webpage bookmarking and snapshotting service

Omnom A webpage bookmarking and snapshotting service. Omnom is a rebooted implementation of @stef's original omnom project, big thanks for it.

Nov 22, 2022

GoatCounter is an open source web analytics platform available as a hosted service or self-hosted app

GoatCounter is an open source web analytics platform available as a hosted service (free for non-commercial use) or self-hosted app. It aims to offer easy to use and meaningful privacy-friendly web analytics as an alternative to Google Analytics or Matomo.

Dec 29, 2022

Minimal go library to relay webhook events back to an arbitrary service.

hookrelay Minimal go library to relay webhook events back to an arbitrary service. With the use of a primary HTTP mux router, we are able to register

Nov 3, 2021

Birthdays is a web service that stores the birthday date of users and calculates the remaining days until the user's birthday.

Birthdays is a web service that stores the birthday date of users and calculates the remaining days until the user's birthday.

Birthdays is a web service that stores the birthday date of users and calculates the remaining days until the user's birthday. Features Metrics servic

May 2, 2022

GoTrue is a small open-source API written in Golang, that can act as a self-standing API service for handling user registration and authentication for Jamstack projects.

GoTrue is a small open-source API written in Golang, that can act as a self-standing API service for handling user registration and authentication for Jamstack projects.

GoTrue is a small open-source API written in Golang, that can act as a self-standing API service for handling user registration and authentication for Jamstack projects.

Dec 13, 2021

Implement a REST API to drive a UI for service management

An implementation an API of the specification the drive a UI for engaging with services of an organization.

Nov 3, 2021

This service finds and — if necessary — generates icons for web sites

This service finds and — if necessary — generates icons for web sites

favicon-service (besticon) This is a favicon service: Supports favicon.ico and apple-touch-icon.png Simple URL API Fallback icon generation Docker ima

Nov 2, 2021
A simple file-based service to stand in for the remote-service proxy on Apigee.

Apigee-Remote-Service-File A simple file-based service to stand in for the remote-service proxy on Apigee. All configuration is done locally in a YAML

Nov 3, 2021
Example golang using gin framework everything you need, i create this tutorial special for beginner.

Golang Gin Framework Fundamental Example golang using gin framework everything you need, i create this tutorial special for beginner. Feature Containe

Dec 16, 2022
This application is used as an example HTTP/SQLite application for Litestream tutorials.

This application is used as an example HTTP/SQLite application for Litestream tutorials. It simply maintains a count of HTTP requests and persists it to a SQLite database.

Apr 2, 2022
A web application example to work with a customer object

Wallester Task This repository contains a web application example to work with a customer object. Build in GO version 1.17.1 Live running app example

Oct 25, 2021
Restful API example with using go and gin framework

simple device api Simple Device API is really simple and concise to show how easy to implement a Restful Service with using Golang. It uses gin framew

Nov 18, 2021
A basic example of a go web server with a react frontend
A basic example of a go web server with a react frontend

GO-React starter This is a basic example of a go web server with a react frontend. It uses the go fiber framework Getting started Running locally Clon

Nov 16, 2021
Advent of Code 2021 example implementation

Advent of Code 2021 example implementation Structure assets/puzzles/<day>.txt contains the puzzle inputs. cmd/<day>/main.go contains the source code d

Dec 15, 2021
A little example about protobuf and Golang

Protocol buffers A little example about protobuf and Golang What is it? - IDL = interface description language - Multilenguage - Optimized serializati

Dec 15, 2021
A simple example application on how a telemetry client can be written

Telemetry Client This is a simple example application on how a telemetry client can be written. Building This application requires that the Go compile

Dec 8, 2021
Go-todo-api - An example API project written Go and Fiber Framework

This is an example API project written Go and Fiber Framework. Test codes has been written for all controller functions. Environment variables are taken from config.yml.

Jan 24, 2022