DEV Community: Thanabodee Charoenpiriyakij

Functional Thinking สำหรับภาษาที่ไม่ใช่แนว Functional Programming

Thanabodee Charoenpiriyakij — Fri, 23 Dec 2022 15:15:22 +0000

ที่บริษัทมี share knowledge เกี่ยวการเอาแนวคิด Functional Programming ไปใช้กับภาษาอื่นที่ไม่ใช่ Functional Programming แล้วในช่วง Q&A มีคนมาถามผม แต่ผมก็ตอบได้ไม่ค่อยชัดเจน เลยคิดว่ายกตัวอย่างมาใส่ใน blog ไว้น่าจะดี

ปล. ผมพยายามจะอธิบายให้คนที่เขียนภาษาอื่นเข้าใจได้ด้วย ถ้าไม่เข้าใจสามารถถามหรือทักท้วงได้ครับ

แยกของที่เป็น side-effect ออกจาก function

side-effect บางคนอาจจะงงว่ามันคืออะไร ลองพิจารณาโค้ดตัวอย่าง

def list_order() do
  date = Date.today()
  query = from(r in Order, where: r.create_date == ^date)
  DB.all(query)
end

โค้ดตัวอย่างเป็นโค้ดที่หา order ทั้งหมดที่อยู่ในวัน ถ้าสังเกตเราจะเห็นของเป็น side-effect อยู่คือ

Date.today() เปลี่ยนตามวันเวลา นั้นหมายความว่าเรียกเหมือนเดิมมันได้ผลลัพธ์ไม่เหมือนเดิม
DB.all(...) เราต่อ database ถ้ามันหายตัว function อาจจะ raise exception หรือ [] ก็ได้ นั้นหมายความว่าเรียกเหมือนเดิมอาจจะไม่เหมือนเดิม

ที่นี้คงพอเห็นภาพใช่ไหมครับ ว่าจริง ๆ แล้วมันคือ function ที่เรียกไปแล้วอาจจะโดนปัจจัยภายนอกทำให้มันได้ผลลัพธ์ไม่เหมือนเดิม แล้วเราจะแก้ปัญหานี้ยังไง? คำตอบนึงที่ผมค้นพบคือแยก function พวกนี้ให้กลายเป็น argument ของ function นั้น ๆ เช่น

def list_order(date_fun, query_all_fun) do
  date = date_fun.()
  query = from(r in Order, where: r.create_date == ^date)
  query_all.()
end

เห็นไหมครับ side-effect หายออกไปจาก function แล้วเพราะเราควบคุมปัจจัยพวกนี้ได้แล้ว เรา test function นี้ได้ด้วยการเปลี่ยนเป็น function อื่นได้ด้วย เช่น

list_order(
  fn -> Date.new(..., ...) end,
  fn query -> [...] end
)

หรือถ้าอยาก integrate test ก็ทำได้

list_order(
  Date.today,
  DB.all
)

คนที่เขียนภาษาแนว Imperative มักจะรู้จักกันดีในชื่อ dependency injection :)

เขียน function ให้เป็น function ย่อย ๆ แล้วนำมาประกอบกัน

ในตอนเริ่มแรกผมมักจะเขียน logic ของ function ให้อยู่ในที่เดียวก่อนยกตัวอย่าง เช่น

def create_order(order_data) do
  order_data.vat = order_data.total_amount * 0.07
  order_data.net = order_data.total_amount + order_data.vat
  ...
end

หลังจากนั้นสิ่งต่อมาที่ผมทำคือแยกพวกนี้ให้เป็น function ย่อย ๆ

def create_order(order_data) do
  order_data.vat = calculate_vat(order_data.total_amount, 0.07)
  order_data.net = calculate_net(order_data.total_amount, order_data.vat)
  ...
end

def calculate_vat(total_amount, rate) do
  total_amount * rate
end

def calculate_net(total_amount, vat) do
  total_amount + vat
end

function จะเริ่มชัดเจนว่า step การทำงานมันเป็นยังไงชัดเจน

มันเริ่มกลายเป็น declarative มากกว่า imperative แล้วเห็นไหมครับ :)

Immutable data

จากตัวอย่างก่อนหน้าเราจะเห็นว่าไปเปลี่ยนค่าใน order_data ในบางภาษา object พวกนี้เป็นแบบ pass by reference มาความว่าเมื่อไหร่ก็ตามที่ function นี้ไป order_data ที่ส่งมาจากคนเรียกจะถูกเปลี่ยนค่าตามไปด้วย นั้นหมายความว่ามันคือ function ที่เป็น side-effect นั้นเอง สิ่งที่เราควรทำคือทำให้แน่ใจว่าการแก้ไขพวกจะต้องไม่ทำให้ไปเปลี่ยน data ภายนอก หนึ่งในวิธีการคือทำการ clone object พวกให้กลายเป็น object ใหม่

def create_order(order_data) do
  order_data_1 = calculate_vat_to_order(clone(order_data), 0.07)
  order_data_2 = calculate_net_to_order(clone(order_data_1))
  ...
end

def calculate_vat_to_order(order_data, rate) do
  # calculate vat and assign here.
  # return new order_data
end

def calculate_net_to_order(order_data, rate) do
  # calculate net and assign here.
  # return new order_data
end

ปล. สำหรับภาษา Functional อาจจะไม่ต้องกังวลเพราะภาษาพวกเป็น immutable by default

ทำ immutable data แล้วดียังไง?

Bug concurrency หลาย ๆ ครั้ง race condition เพราะว่ามี thread พยายาม mutate data เลยเป็นที่มาว่า Functional Programming เลยแก้เกมด้วยการ copy data ให้หมดเพืื่อลดอาการนี้

เคส let's encrypt ที่เคยต้องมีการ rotate cert ทุกใบก็เพราะว่าไป mutate data ที่ไม่ควรจะ mutate สุดท้ายก็ต้อง copy data ก่อน

มันไม่เปลือง memory เหรอ?

คำตอบคือเปลืองขึ้นครับ ฮาาา การทำ immutable data ดีอย่างนึงคือมีโอกาสที่ Garbage Collector จะ clear ได้เร็วขึ้นเนื่องจากมันเห็นว่าไม่มีใครใช้แล้ว หรือบางภาษาแนว ๆ Rust ก็อาจจะ clear ไปหลังจบการทำงานของ function เลย ทั้งนี้ทั้งนั้นขึ้นกับ size ของ data ที่เรา copy ไปครับ map สี่ห้า field อาจจะไม่เห็นผลอะไรครับ

ผมคิดว่าน่าจะพอเห็นภาพคร่าว ๆ บ้างแล้ว หวังว่าจะเอามันไปประยุกต์ต่อได้ครับ :)

From UNIX command to PowerShell command

Thanabodee Charoenpiriyakij — Fri, 25 Jun 2021 15:29:53 +0000

ลอง map command จาก os ตระกูล UNIX ที่ใช้ในชีวิตประจำวันมาเป็น PowerShell ของ Windows

mkdir

สร้างโฟลเดอร์

UNIX:

$ mkdir powershell_tut

PowerShell:

PS> New-Item -ItemType "directory" powershell_tut

cd

เปลี่ยนโฟลเดอร์

UNIX:

$ cd powershell_tut

PowerShell:

PS> Set-Location powershell_tut

touch

สร้างไฟล์

UNIX:

$ touch a.txt

PowerShell:

PS> New-Item a.txt

cp

Copy ไฟล์จากต้นทางไปปลายทาง

UNIX:

$ cp a.txt b.txt
$ cp -r dir_a dir_b

PowerShell:

PS> Copy-Item a.txt b.txt
PS> Copy-Item -Recurse dir_a dir_b

rm

ลบไฟล์หรือโฟลเดอร์

UNIX:

$ rm a.txt
$ rm -r dir_a
$ rm -rf dir_b

PowerShell:

PS> Remove-Item a.txt
PS> Remove-Item -Recurse dir_a
PS> Remove-Item -Recurse -Force dir_b

mv

ย้ายไฟล์หรือโฟลเดอร์

UNIX:

$ mv dir_b dir_c

PowerShell:

PS> Move-Item dir_b dir_c

ls

List ไฟล์หรือโฟลเดอร์นั้น ๆ

UNIX:

$ ls

PowerShell:

PS> Get-ChildItem

man

ดู manual ของโปรแกรมนั่น ๆ

UNIX:

$ man cp

PowerShell:

PS> Get-Help Copy-Item

curl

Request data จาก url ที่ระบุ

UNIX:

$ curl http://example.com

PowerShell:

PS> Invoke-RestMethod -Uri http://example.com

"do" magic keyword option

Thanabodee Charoenpiriyakij — Mon, 30 Nov 2020 14:58:27 +0000

สิ่งมหัศจรรย์ของ Elixir คือ เราใช้ Keyword ที่มี key ชื่อ do เพื่อทำ do block ใน DSL ได้ เช่น

defmodule SoLazy do
  defmacro resources(path, do: nested_context) do
    quote do
      IO.puts("Print #{unquote(path)}")
      unquote(nested_context)
    end
  end
end

ก็จะทำให้เราเรียกแบบนี้ได้

$ iex
Erlang/OTP 23 [erts-11.1.3] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [hipe] [dtrace]

Interactive Elixir (1.11.1) - press Ctrl+C to exit (type h() ENTER for help)
iex(1)> require SoLazy
SoLazy
iex(2)> SoLazy.resources "/myapi" do
...(2)>   IO.puts "nested context"
...(2)> end
Print /myapi
nested context
:ok

จบ...

Rustler 101: Ferris Say

Thanabodee Charoenpiriyakij — Thu, 17 Sep 2020 15:44:21 +0000

สร้าง Elixir Project ด้วย mix

$ mix new ferris_ex --module FerrisEx

ใส่ rustler เข้าไปใน mix dependencies

defp deps do
  [
    {:rustler, "~> 0.21.1"}
  ]
end

หลังจากนั้นก็สั่ง mix deps.get เพื่อ fetch dependencies

ต่อมา generate rust project ผ่าน rustler ก็จะมี prompt ให้ใส่ชื่อ module ลงไป ผมใส่ module ชื่อ FerrisEx.Native และชื่อ rust library ก็ตามน้ำมันไป

$ mix rustler.new
==> toml
Compiling 10 files (.ex)
Generated toml app
==> rustler
Compiling 5 files (.ex)
Generated rustler app
==> ferris_ex
This is the name of the Elixir module the NIF module will be registered to.
Module name > FerrisEx.Native
This is the name used for the generated Rust crate. The default is most likely fine.
Library name (ferrisex_native) >
* creating native/ferrisex_native/.cargo/config
* creating native/ferrisex_native/README.md
* creating native/ferrisex_native/Cargo.toml
* creating native/ferrisex_native/src/lib.rs
Ready to go! See /Users/thanabodee/src/github.com/wingyplus/ferris_ex/native/ferrisex_native/README.md for further instructions.

ต่อมาเปิด Cargo.toml ซึ่งอยู่ใน $PWD/native/ferrisex_native/Cargo.toml แล้วทำการใส่ library ชื่อ ferris_says ลงไป

[dependencies]
rustler = "0.21.1"
lazy_static = "1.0"
...
ferris-says = "0.2"

และทำการแก้โค้ดของ lib.rs ให้เป็น function ตามที่เราต้องการ

use ferris_says;
use rustler::{Encoder, Env, Error, Term};
use std::io;
use std::str;

mod atoms {
    rustler::rustler_atoms! {
        atom ok;
    }
} // 1

rustler::rustler_export_nifs! {
    "Elixir.FerrisEx.Native",
    [
        ("say", 1, say)
    ],
    None
} // 2

fn say<'a>(env: Env<'a>, args: &[Term<'a>]) -> Result<Term<'a>, Error> {
    let text: String = args[0].decode()?;

    let mut cursor = io::Cursor::new(Vec::new());
    ferris_says::say(&text.into_bytes(), 24, &mut cursor).unwrap();
    Ok((atoms::ok(), str::from_utf8(&cursor.into_inner()).unwrap()).encode(env))
} // 3

จาก snippet ข้างบน

ประกาศ atom ที่เราจะใช้ใน rust library
ประกาศ function ใน module FerrisEx.Native
implement function

เสร็จแล้วก็สั่ง cargo build เพื่อให้ rust สร้าง dynamic library ขึ้นมา

ต่อมาทำการสร้าง elixir module เพื่อ binding กับ rust library ของเรา

# ./lib/ferris_ex/native.ex
defmodule FerrisEx.Native do
  use Rustler, otp_app: :ferris_ex, crate: :ferrisex_native

  def say(_text), do: :erlang.nif_error(:nif_not_loaded)
end

เพื่อที่จะทำการ binding กับ rust library ของเราได้ต้องใช้ use Rustler และบอกว่าจะผูกกับ crate ชื่ออะไรของเรา และต้องมี function dummy เพื่อกรณีที่ elixir binding nif ไม่ได้

เสร็จแล้วก็ copy dynamic library ที่ได้จาก cargo build มาไว้ที่ priv/native ของ elixir

$ cp ./native/ferrisex_native/target/debug/libferrisex_native.dylib ./priv/native/libferrisex_native.so

หลังจาก copy แล้วก็ทำการเปิด iex ขึ้นมาเพื่อทดสอบ binding ของเรา

iex(1)> {:ok, out} = FerrisEx.Native.say("Hello, I'm Ferris.")
{:ok,
 " ____________________\n< Hello, I'm Ferris. >\n --------------------\n        \\\n         \\\n            _~^~^~_\n        \\) /  o o  \\ (/\n          '_   -   _'\n          / '-----' \\\n"}
iex(2)> IO.puts(out)
 ____________________
< Hello, I'm Ferris. >
 --------------------
        \
         \
            _~^~^~_
        \) /  o o  \ (/
          '_   -   _'
          / '-----' \

:ok

เรียน C# Syntax จาก Unity

Thanabodee Charoenpiriyakij — Sun, 26 Jul 2020 15:23:28 +0000

ถ้าใครได้ลอง Unity จะได้เห็น type นึงที่ใช้ประจำนั่นคือ Vector2 และ Vector3 ซึ่ง blog นี้ผมจะลองทำความเข้าใจ C# จาก type ทั้งสองอันนี้กัน โดยยกตัวอย่างจาก Vector2 เป็นหลัก

ปล. หน้าตาอาจจะไม่เหมือนกันเป๊ะ แต่จุดประสงค์คือเพื่อให้อ่านโค้ดของ C# รู้เรื่อง -/-

1. Struct

Vector2 ถูกประกาศเป็น type struct เราสามารถประกาศได้แบบนี้

public struct Vector2
{
    public float x, y;
}

ข้อดีของ struct คือมันจะ copy data ซึ่งทำให้ไม่มีผลกระทบอะไรเวลาเราส่งค่าไปให้อีก method แล้วมีการ modify เช่น

[TestFixture]
public class LearnStructTests
{
    private void ModifyVector2(Vector2 vec)
    {
        vec.x = 2;
    }

    [Test]
    public void TestStruct()
    {
        var vec = new Vector2
        {
            x = 1,
            y = 20
        };
        ModifyVector2(vec);
        Assert.AreEqual(1, vec.x);
    }
}

ในตัวอย่าง เมื่อเราเรียก ModifyVector2 ซึ่งภายใน method นั้นมีการเปลี่ยน field x ของตัวแปร vec แต่ค่าของ vec ภายใน TestStruct กลับไม่ถูกเปลี่ยนแปลงแต่อย่างใด

2. Operator Overloading

อีก 1 feature ที่จะถูกใช้บ่อยใน Unity คือการลบ vector เพื่อเอาไปหาทิศทางที่จะเดินไป เช่น

// In Unity.
var target = new Vector2(10, 34);
var player = new Vector2(1, 2);
var direction = (target - player).normalized;

Unity ใช้ feature ของ C# ที่เรียกว่า operator overloading ในการทำให้การลบ vector เหมือนลบเลข โดยเราสามารถ declare operator - ได้แบบนี้

public struct Vector2
{
    public float x, y;

    public static Vector2 operator -(Vector2 a, Vector2 b)
        => new Vector2{x = a.x - b.x, y = a.y - b.y};
}

3. String formatting

ใน type Vector2 implement interface IFormattable เพื่อให้ Vector2 สามารถแปลงเป็นข้อความที่อ่านรู้เรื่องใน debug console โดยเราสามารถทำได้แบบนี้

public struct Vector3 : IFormattable
{
    public float x, y;

    public static Vector2 operator -(Vector2 a, Vector2 b)
        => new Vector2 {x = a.x - b.x, y = a.y - b.y};

    public string ToString(string format, IFormatProvider formatProvider)
    {
        if (string.IsNullOrEmpty(format))
        {
            format = "F1";
        }

        return $"({x.ToString(format, formatProvider)}, {y.ToString(format, formatProvider)})";
    }
}

IFormattable จะให้เรา implements string ToString(string, IFormatProvider) เพื่อคืนค่า string ที่ format แล้วกลับไปให้ เท่านี้เราก็จะใช้ string interpolation ได้แบบนี้

var vec = new Vector2{x = 1, y = 2};
Assert.AreEqual("(1.0, 2.0)", $"{vec}");

สังเกตว่าผมมี check if ตรง format ไว้ใน ToString สาเหตุเพราะว่าใน C# สามารถกำหนดรูปแบบของ format ได้เช่น

Assert.AreEqual("(1.00, 2.00)", $"{vec:F2}");

สังเกตใน string interpolation สามารถกำหนด format โดยใช้ : ตามด้วย format ที่ต้องการ ผมใช้ F2 เพื่อบอกให้ format เป็นทศนิยม 2 ตำแหน่ง

โค้ดเต็มดูได้ที่นี่ครับ https://gist.github.com/wingyplus/08656ff8da061445f39a0af8c052e0c4/08656ff8da061445f39a0af8c052e0c4

Validate signature สำหรับ LINE webhook

Thanabodee Charoenpiriyakij — Thu, 02 Apr 2020 16:05:26 +0000

LINE webhook api มีสิ่งขั้นตอนนึงที่ต้องทำคือการ validate signature เพื่อยืนยันว่า request ที่เข้ามานั้นมาจาก Official Account ของเราจริงๆ ซึ่งถ้าใช้ภาษาที่ official LINE support แล้วละก็จะมีจะ function ให้ใช้งานอย่าง line-bot-sdk-go ที่มี ParseRequest(*http.Request) ให้ใช้งานก็จะ validate signature จาก request header ให้อัตโนมัติ

ถ้าลองลอกการทำงานของ validate signature เพื่อนำมาทำ webhook ใน Elixir น่าจะได้ประมาณนี้

ขั้นตอนแรกสร้าง hash ด้วย HMAC-SHA256 โดยใช้ key เป็น channel secret และ data เป็น request body ที่ LINE ส่งเข้ามา function จะได้หน้าตาประมาณนี้

defp sign_signature(channel_secret, body) do
  :crypto.hmac(:sha256, channel_secret, body)
end

จากนั้น encode ด้วย base64 จะได้ signature ที่ LINE ส่งมาทาง request header ซึ่งใช้ pipe operator pipe ตัว hash ที่เราสร้างเข้าไป Base.encode เลยจะง่ายกว่า

defp sign_signature(channel_secret, body) do
  :crypto.hmac(:sha256, channel_secret, body) |> Base.encode64()
end

จากนั้นเอา signature ที่ได้ไป compare กับ signature จาก request header

def validate(signature, body, channel_secret) do
  validate(signature, sign_signature(channel_secret, body))
end

defp validate(signature, signature), do: :ok
defp validate(_, _), do: :invalid_signature

ผมสร้าง validate/3 เพื่อรับ signature จาก request header แล้วส่งเข้าไปที่ validate/2 เพื่อใช้ pattern matching ดูว่าเป็น signature เดียวกันก็จะตอบ :ok ไปเลยส่วน case อื่นก็ถือว่า :invalid_signature ไป

ปล. จริงๆ จะใช้ case <> do ... end ก็ได้ไม่ว่ากัน เพราะความตั้งใจผมคือต้องการแยกเคสให้อ่านง่าย

ผมลองสร้างตัวอย่างโดย port มาจาก echo_bot ที่อยู่ใน line-bot-sdk-go ที่นี่ลองดูหรือ discuss กันได้ครับ :)

ข้อควรระวัง

LINE จะ sign signature โดยรวม space ใน request body กรณีนี้จะเจอตอนที่ LINE ส่ง body แบบ indent JSON มาให้ซึ่งหากเราใช้ Plug.Parsers แล้วมาดูจาก conn.body_params อาจจะผิดได้ (เคสนี้ผมเจอตอน verify webhook หาอยู่พักนึงถึงเข้าใจ)

Vue 101 จาก Elm

Thanabodee Charoenpiriyakij — Tue, 17 Mar 2020 12:43:49 +0000

หากจะทำแบบนี้ใน Vue โดยเทียบกับ Elm จากตัวอย่าง counter app https://ellie-app.com/8kChZLnNmfta1

Elm mount app โดยใช้

var app = Elm.Main.init({ node: document.querySelector('main') })

Vue ก็ทำโดยสร้าง Vue instance โดย

new Vue({ render: h => h(App) }).$mount('#app')

view ใน Elm เป็น function ที่รับ data (หรือเรียกว่า Model)

view model =
    div []
        [ button
            [ onClick Increment ]
            [ text "+" ]
        , p
            []
            [ text <| String.fromInt model ]
        , button
            [ onClick Decrement ]
            [ text "-" ]
        ]

ใช้ Vue แบบ single file component จะใช้ tag template

<template>
  <div>
    <button @click="increment()">+</button>
    <p>{{ count }}</p>
    <button @click="decrement()">-</button>
  </div>
</template>

Elm ต้อง initialize data ผ่าน init และ manage logic ด้วย update function

init =
    0


update msg model =
    case msg of
        Increment ->
            model + 1

        Decrement ->
            model - 1

ส่วน Vue ก็คล้ายกันโดยมี data และ methods

<script>
export default {
  data: () => ({
    count: 0
  }),
  methods: {
    increment() {
      this.count++
    },
    decrement() {
      this.count--
    }
  }
};
</script>

แต่สิ่งที่มันต่างกับ Elm คือ update ของ Elm ใช้ update view ทั้ง application ส่วน Vue update เพียงแค่ใน component ถ้าอยากจะให้ update ทั้ง component ต้องใช้ vuex ช่วยโดยแยก data และการ update ออกมาจาก component

Vue.use(Vuex)

const store = new Vuex.Store({
  state: {
    count: 0
  },
  mutations: {
    increment(state) {
      state.count += 1
    },
    decrement(state) {
      state.count -= 1
    }
  }
})

new Vue({
  store,
  render: h => h(App),
}).$mount('#app')

จากนั้นใช้วิธีการ commit mutation เข้าไปจากใน component

<script>
export default {
  name: "App",
  computed: {
    count() {
      return this.$store.state.count;
    }
  },
  methods: {
    increment() {
      this.$store.commit("increment");
    },
    decrement() {
      this.$store.commit("decrement");
    }
  }
};
</script>

ลองเทียบ state จาก state debugger

ของ Elm

ของ Vuex

ใช้งาน Jaeger trace ร่วมกับ OpenTelemetry

Thanabodee Charoenpiriyakij — Mon, 10 Feb 2020 06:41:20 +0000

จากบทความ ที่แล้วเราใช้ exporter เป็นแบบ stdout เพื่อส่ง traces ออกไปที่ stdout ของ os คราวนี้เราจะมาใช้งานร่วมกับ Jaeger กัน

ในบทความนี้ผมใช้ jaeger แบบ all-in-one เพื่อให้ง่ายต่อการ setup และทดสอบโดยสามารถได้ด้วย docker แบบนี้

$ docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 9411:9411 \
  jaegertracing/all-in-one:1.8

จากนั้นเราจะเปลี่ยน exporter จาก stdout เป็น jaeger โดยใช้ package go.opentelemetry.io/otel/exporter/trace/jaeger

$ go get -v go.opentelemetry.io/otel/exporter/trace/jaeger@v0.2.1

import (
    // ...
    "go.opentelemetry.io/otel/exporter/trace/jaeger"
)

// in initTrace().
exporter, err := jaeger.NewExporter(
    jaeger.WithCollectorEndpoint("http://localhost:14268/api/traces"),
    jaeger.WithProcess(
        jaeger.Process{
            ServiceName: "github.com/wingyplus/basic",
        },
    ),
)
if err != nil {
    log.Fatalf("have some problems while creating jaeger exporter: %v", err)
}

จากนั้นทำการรันด้วย go run และเปิด Jaeger UI มาดูผ่าน http://localhost:16686 จะเห็นแบบรูปด้านล่าง

มาเริ่มต้นใช้งาน tracing กับ OpenTelemetry ด้วย Go

Thanabodee Charoenpiriyakij — Sun, 09 Feb 2020 12:19:51 +0000

OpenTelemetry เป็นโครงการเพื่อช่วยจัดการเรื่อง tracing กับ metrics และทำให้ application ไม่เกิด vendor lock-in กับระบบ tracing หรือ metrics เจ้าใดเจ้านึง ซึ่งโครงการนี้ต่อยอดมาจาก OpenTracing กับ OpenCensus และทำตามมาตรฐาน W3 Tracing Context (ผมยังไม่ได้อ่านรายละเอียดของ Tracing Context มากเท่าไหร่ เดี๋ยวว่างๆ ค่อยมาสรุปอีกที)

เจ้าตัว OpenTelemetry เองก็ support programming language หลายภาษาอยู่เหมือน เช่น Go, Java, Python, Erlang, Rust เป็นต้น โดยในบล็อคนี้จะเน้น Go และการทำ tracing เป็นหลัก (ภาษาอื่นเขียนไม่เป็น 555)

ขั้นแรกสร้าง module

$ mkdir otel-todo
$ cd otel-todo && go mod init github.com/wingyplus/otel-todo
go: creating new go.mod: module github.com/wingyplus/otel-todo

ทำการ initialize tracing

ในการ initialize tracing นั้นจะมีสามขั้นตอน ขั้นแรกคือสร้าง exporter เพื่อบอก OpenTelemetry ว่าจะ export trace ไปที่ระบบไหน ซึ่งตอนนี้ opentelemetry-go ซัพพอร์ตแค่สามระบบ

stdout ง่ายๆ คือ print ออก stdout ในรูปแบบ json format
jaeger เป็นระบบ distributed tracing ของ Uber
stackdriver ของ Google Cloud

ตอนนี้เราจะเริ่มง่ายๆ ด้วยการใช้ stdout ก่อน

// main.go
package main

import (
    "log"

    "go.opentelemetry.io/otel/exporter/trace/stdout"
)

func initTrace() {
    exporter, err := stdout.NewExporter(stdout.Options{PrettyPrint: true})
    if err != nil {
        log.Fatalf("have some errors while creating stdout exporter: %v", err)
    }

    // ...
}

ต่อมาทำการสร้าง provider เพื่อบอกความถี่ในการ sync trace ไปหา exporter

import (
    // ...
    sdktrace "go.opentelemetry.io/otel/sdk/trace"
)


// in initTrace().
provider, err := sdktrace.NewProvider(
    sdktrace.WithConfig(sdktrace.Config{DefaultSampler: sdktrace.AlwaysSample()}),
    sdktrace.WithSyncer(exporter),
)
if err != nil {
    log.Fatalf("have some problems while creating provider: %v", err)
}

ในตัวอย่างข้างบนนั้นผมใส่เป็น AlwaysSample() เพื่อเอาทุก trace ที่เกิดขึ้นในระบบ

ขั้นตอนสุดท้ายทำการ set provider เข้าไปที่ package global

import (
    // ...
    "go.opentelemetry.io/otel/api/global"
)

// in initTrace().
global.SetTraceProvider(provider)

ใช้งาน tracing

ขั้นแรกทำการดึง provider ออกมาจาก global

func main() {
    initTrace()

    tracer := global.TraceProvider().Tracer("github.com/wingyplus/basic")
}

จากนั้นทำการสร้าง span ด้วย tracer.WithSpan

// in main().
tracer.WithSpan(context.Background(), "foo", func(ctx context.Context) error {
    return nil
})

ลองทดสอบการทำงานด้วย go run

$ go run .
{
        "SpanContext": {
                "TraceID": "5883cc5d9604907026cf1cc8f651206a",
                "SpanID": "73ebe6c408d24147",
                "TraceFlags": 1
        },
        "ParentSpanID": "0000000000000000",
        "SpanKind": 1,
        "Name": "github.com/wingyplus/basic/foo",
        "StartTime": "2020-02-09T19:10:49.844055+07:00",
        "EndTime": "2020-02-09T19:10:49.844060721+07:00",
        "Attributes": null,
        "MessageEvents": null,
        "Links": null,
        "Status": 0,
        "HasRemoteParent": false,
        "DroppedAttributeCount": 0,
        "DroppedMessageEventCount": 0,
        "DroppedLinkCount": 0,
        "ChildSpanCount": 0
}

เราสามารถสร้าง span ภายใน WithSpan ได้อีกโดยใช้ context ของ WithSpan ที่เป็นตัว root เช่น

tracer.WithSpan(context.Background(), "foo", func(ctx context.Context) error {
    tracer.WithSpan(ctx, "bar", func(ctx context.Context) error {
        return nil
    })
    return nil
})

ถ้าลองรันดู จะเห็นว่าจะมีสอง span เกิดขึ้นมา

$ go run .
{
    "SpanContext": {
        "TraceID": "58e32b2438efda4d90db7b0ce0db9371",
        "SpanID": "040c29233e95fca5",
        "TraceFlags": 1
    },
    "ParentSpanID": "8fc213b9e9b84a98",
    "SpanKind": 1,
    "Name": "github.com/wingyplus/basic/bar",
    "StartTime": "2020-02-09T19:13:36.753668+07:00",
    "EndTime": "2020-02-09T19:13:36.75367142+07:00",
    "Attributes": null,
    "MessageEvents": null,
    "Links": null,
    "Status": 0,
    "HasRemoteParent": false,
    "DroppedAttributeCount": 0,
    "DroppedMessageEventCount": 0,
    "DroppedLinkCount": 0,
    "ChildSpanCount": 0
}
{
    "SpanContext": {
        "TraceID": "58e32b2438efda4d90db7b0ce0db9371",
        "SpanID": "8fc213b9e9b84a98",
        "TraceFlags": 1
    },
    "ParentSpanID": "0000000000000000",
    "SpanKind": 1,
    "Name": "github.com/wingyplus/basic/foo",
    "StartTime": "2020-02-09T19:13:36.753663+07:00",
    "EndTime": "2020-02-09T19:13:36.754156451+07:00",
    "Attributes": null,
    "MessageEvents": null,
    "Links": null,
    "Status": 0,
    "HasRemoteParent": false,
    "DroppedAttributeCount": 0,
    "DroppedMessageEventCount": 0,
    "DroppedLinkCount": 0,
    "ChildSpanCount": 1
}

จะสังเกตเห็นว่า span ที่มีชื่อว่า "github.com/wingyplus/basic/bar" จะมี parent เป็น "8fc213b9e9b84a98" ซึ่งเป็น span id ที่อยู่ใน SpanContext ของ span ที่ชื่อ "github.com/wingyplus/basic/foo"

ที่นี่ลองหน่วงการทำงานของ span ดู

// in main().
tracer.WithSpan(context.Background(), "foo", func(ctx context.Context) error {
    time.Sleep(3 * time.Second)
    tracer.WithSpan(ctx, "bar", func(ctx context.Context) error {
        time.Sleep(5 * time.Second)
        return nil
    })
    return nil
})

$ go run .
{
    "SpanContext": {
        "TraceID": "cbbff287daac4270963300393e1122f4",
        "SpanID": "6a7e00be07802205",
        "TraceFlags": 1
    },
    "ParentSpanID": "a7afe9f612e34427",
    "SpanKind": 1,
    "Name": "github.com/wingyplus/basic/bar",
    "StartTime": "2020-02-09T19:16:30.103175+07:00",
    "EndTime": "2020-02-09T19:16:35.106123127+07:00",
    "Attributes": null,
    "MessageEvents": null,
    "Links": null,
    "Status": 0,
    "HasRemoteParent": false,
    "DroppedAttributeCount": 0,
    "DroppedMessageEventCount": 0,
    "DroppedLinkCount": 0,
    "ChildSpanCount": 0
}
{
    "SpanContext": {
        "TraceID": "cbbff287daac4270963300393e1122f4",
        "SpanID": "a7afe9f612e34427",
        "TraceFlags": 1
    },
    "ParentSpanID": "0000000000000000",
    "SpanKind": 1,
    "Name": "github.com/wingyplus/basic/foo",
    "StartTime": "2020-02-09T19:16:27.102542+07:00",
    "EndTime": "2020-02-09T19:16:35.107031106+07:00",
    "Attributes": null,
    "MessageEvents": null,
    "Links": null,
    "Status": 0,
    "HasRemoteParent": false,
    "DroppedAttributeCount": 0,
    "DroppedMessageEventCount": 0,
    "DroppedLinkCount": 0,
    "ChildSpanCount": 1
}

จะเห็นว่า span "github.com/wingyplus/basic/foo" จะมี start time กับ end time ห่างกันประมาณ 8 วินาที เพราะ span "github.com/wingyplus/basic/bar" ใช้เวลา 5 วินาทีนั่นเอง

หัด Erlang and Elixir v0.3.0 - atom

Thanabodee Charoenpiriyakij — Wed, 08 Jan 2020 14:26:17 +0000

atom ใน Erlang ขึ้นด้วยด้วยอักษรตัวเล็ก หรือใช้ ' ครอบ text เอา

6> centimeter.
centimeter
7> 'Centimeter'.
'Centimeter'
8> 'Centi meter'.
'Centi meter'

ส่วนของ Elixir ใช้ : นำหน้าหรือขึ้นต้นด้วยตัวอักษรตัวใหญ่ ถ้าอยากจะใช้ ' แบบ Erlang ให้เติม : เข้าไป

iex(1)> :centimeter
:centimeter
iex(2)> :'Centimeter'
:Centimeter
iex(3)> :'Centi meter'
:"Centi meter"
iex(13)> This_is_greeting
This_is_greeting

ทั้งสองภาษามี function is_atom เพื่อเอาไว้ตรวจสอบว่า value นั้นเป็น atom หรือไม่

9> is_atom(centimeter).
true
10> is_atom('Centimeter').
true
11> is_atom('Centi meter').
true

iex(4)> is_atom(:centimeter)
true
iex(5)> is_atom(:'Centimeter')
true
iex(6)> is_atom(:'Centi meter')
true
iex(15)> is_atom(This_is_greeting)
true

boolean ของทั้งสองภาษาก็เป็น atom เช่นเดียวกัน

12> is_atom(true).
true
13> is_atom(false).
true

iex(7)> is_atom(true)
true
iex(8)> is_atom(false)
true

NOTE: ที่เราเห็น true/false ใน Elixir ใน atom นั้นสาเหตุเพราะ compiler จะแปลง true/false ให้กลายเป็น :true กับ :false ที่เราใช้ตัวอักษรตัวใหญ่เคสนั้นก็น่าจะทำนองเดียวกัน

Module ใน Elixir และ Erlang เองก็เป็น atom เหมือนกันนะ

14> is_atom(lists). %% module lists
true

iex(1)> is_atom(List) ## module List
true

NOTE: ในเคสของ Elixir จะแปลงไปเป็น :'Elixir.List ให้เองโดย compiler

หัด Erlang and Elixir v0.2.0 - variable

Thanabodee Charoenpiriyakij — Wed, 08 Jan 2020 14:03:23 +0000

การสร้างตัวแปรใน Erlang นั้นจะใช้ชื่อตัวแปรขึ้นต้นด้วยตัวอักษรตัวใหญ่

1> Greeting = "hello".
"hello"
2> Greeting.
"hello"

ใน Erlang นั้นจำเป็นต้องใช้ . เป็นตัว end statement เสมอ และ assign ให้ตัวแปรเดิมทับไม่ได้

3> Greeting = "new hello".
** exception error: no match of right hand side value "new hello"

NOTE: ใน Erlang shell เราสามารถทำยกเลิก variable binding ได้ด้วยการใช้ function f() เช่น

4> f(Greeting).
ok
5> Greeting = "new hello".
"new hello"

ส่วนของ Elixir นั้นใช้ขึ้นด้วยตัวเล็ก

iex(1)> greeting = "hello"
"hello"
iex(2)> greeting
"hello"

แถมต่างกับ Erlang ตรง assign ทับได้

iex(3)> greeting = "new hello"
"new hello"
iex(4)> greeting
"new hello"

แต่ถ้าอยากไม่ให้ re-assign ค่าใหม่ที่ไม่ใช่ค่าเดิมได้ จะต้องใช้ ^ นำหน้าตัวแปร Elixir จะทำการ match value ระหว่างสองข้างให้

iex(5)> ^greeting = "hello"
** (MatchError) no match of right hand side value: "hello"
    (stdlib) erl_eval.erl:453: :erl_eval.expr/5
    (iex) lib/iex/evaluator.ex:257: IEx.Evaluator.handle_eval/5
    (iex) lib/iex/evaluator.ex:237: IEx.Evaluator.do_eval/3
    (iex) lib/iex/evaluator.ex:215: IEx.Evaluator.eval/3
    (iex) lib/iex/evaluator.ex:103: IEx.Evaluator.loop/1
    (iex) lib/iex/evaluator.ex:27: IEx.Evaluator.init/4
iex(5)> ^greeting = "new hello" # สามารถ assign ได้เพราะค่าทางด้านขวาเป็นค่าเดียวกับด้านซ้าย
"new hello"

หัด Erlang and Elixir v0.1.0

Thanabodee Charoenpiriyakij — Mon, 06 Jan 2020 16:18:59 +0000

หลังจากไปงาน Elixir meetup ครั้งที่ผ่านมา สารภาพว่าไปไม่ทัน แถมไม่รู้เรื่องอะไรกับเค้าเลย T_T) เลยอยากลองสรุปเรื่อง Erlang กับ Elixir นิดหน่อย

NOTE: ผมใช้ macOS นะ

การติดตั้ง

ทั้งสองภาษาติดตั้งได้ผ่าน brew

# Erlang
$ brew install erlang

# Elixir
$ brew install elixir

REPL

ทั้งสองภาษามี repl bundle มาให้ในตัว โดย Erlang นั้นจะใช้ชื่อว่า erl พอเราสั่งคำสั่งนี้ก็จะเปิด repl มาให้เลย

$ erl
Erlang/OTP 22 [erts-10.6.1] [source] [64-bit] [smp:12:12] [ds:12:12:10] [async-threads:1] [hipe] [dtrace]

Eshell V10.6.1  (abort with ^G)
1>

ส่วนของ Elixir นั้นใช้ชื่อว่า iex ก็จะหน้าตาคล้ายกันหน่อย

Erlang/OTP 22 [erts-10.6.1] [source] [64-bit] [smp:12:12] [ds:12:12:10] [async-threads:1] [hipe] [dtrace]

Interactive Elixir (1.9.4) - press Ctrl+C to exit (type h() ENTER for help)
iex(1)>

หากถ้าอยากออกทั้งสอง shell ทำได้เหมือนกันเลยคือกด Ctrl-C จากนั้นกด a แล้ว Enter :)

Hello, World

เริ่มที่ Erlang ก่อนเลย

% hello_module.erl
-module(hello_module).
-export([hello/0]).

hello() ->
    io:format("~s~n", ["Hello, World"]).

Erlang มีกฎอยู่ว่าไฟล์ 1 ไฟล์จะประกอบไปด้วย 1 module และชื่อไฟล์ต้องตรงกับชื่อ module นั้นๆ ซึ่ง module จะต้องประกาศโดยใช้ -module(<module_name>). เสมอ จากนั้นเราต้องบอกด้วยว่า module นี้จะ export function อะไรบ้าง สังเกตว่าจะมี /0 ต่อหลัง hello นั้นหมายความว่าให้ export function hello ที่มีจำนวน arguments 0 ตัว เดี๋ยวไว้อธิบายทีหลังจากว่ามีทำไม

ตัว function นั้นจะใช้ -> เพื่อเปิด function body และใช้ . เพื่อบอกว่าจบ function แล้ว

ต่อมาคือการ compile เราสามารถ compile ได้ผ่าน erl โดยใช้ function ชื่อ c():

1> c(hello_module).
{ok,hello_module}

หาก compile ผ่าน c จะตอบกลับมาว่า ok กับชื่อ module ที่มัน compile ผ่านแล้ว

ทีนี้มา Elixir บ้าง

กฎการตั้งชื่อไฟล์จะคล้ายๆ กัน แต่นามสกุลไฟล์เป็น .ex

# hello_module.ex

defmodule HelloModule do
  def hello() do
    IO.puts "Hello, World"
  end
end

การประกาศ module ของ Elixir นั้นใช้ keyword defmodule ตามด้วยชื่อ module ซึ่งจะใช้ pascal case กัน

การประกาศ function ใช้ keyword def ตามด้วยชื่อ function และใช้ do และ end เพื่อเปิดและปิด function body

การ compile นั้นใช้ c() เหมือนกันแต่ต่างกันตรง Elixir จะใส่ชื่อไฟล์แทนชื่อ module:

iex(1)> c("hello_module.ex")
[HelloModule]

เรียก function

ทั้งสองภาษาจะคล้ายกันโดยใช้ชื่อ module ตามด้วย function และ arguments แต่ต่างกันนิดหน่อยตรง syntax โดย Erlang ใช้ <module>:<function>(<args...>).

2> hello_module:hello().
Hello, World
ok

ส่วน Elixir ใช้

iex(2)> HelloModule.hello()
Hello, World
:ok

อีกหนึ่งความแตกต่างคือ Elixir ยอมให้เรียก function โดยไม่ใส่ () ได้ เช่น

iex(2)> HelloModule.hello
Hello, World
:ok

พอล่ะ ง่วง zZZ