[OpenCensus - Trace] Opencensus를 이용한 gRPC Trace 와 Metrics 처리하기

<h1>Opencensus를 이용한 gRPC Global Tracing</h1>
<h2>Overview</h2>
<p>Opencensus를 사용해서 시스템의 추적 및 매트릭을 수집하고 선택한 백엔드로 내보내 분산 시스템에 대한 관찰성을 제공할 수 있다.</p>
<p>간단하게 gRPC 상에서 추적을 검증하기 위한 용도이므로 단순히 바이트를 포함하는 페이로드를 받아서 대문자 처리를 하는 서비스를 대상으로 검토해 보도록 한다.</p>
<h2>Requirements</h2>
<ul>
<li><p>go : <a href="https://golang.org/doc/install">Download and install - The Go Programming Language</a> 를 통해 설치</p>
</li>
<li><p>gRPC</p>
<pre><code>$ go get -u google.golang.org/grpc
</code></pre></li>
<li><p>Protocol Buffer v3 : <a href="https://grpc.io/docs/languages/go/quickstart/#install-protocol-buffers-v3">Quick start – gRPC</a> 문서의 내용에 따라서 <a href="https://github.com/protocolbuffers/protobuf/releases">Releases · protocolbuffers/protobuf · GitHub</a> 에서 바이너리를 받을 수 있다.</p>
<pre><code># linux apt or apt-get
$ apt install -y protobuf-compiler
$ protoc --verion # 버전 3+ 확인

# Mac Homebrew
$ brew install protobuf
$ protoc --version # 버전 3+ 확인</code></pre></li>
<li><p>Go 용 protoc 플러그인</p>
<pre><code>$ go get -u github.com/golang/protobuf/protoc-gen-go</code></pre></li>
</ul>
<h2>Creating our gRPC Service</h2>
<p>추적을 활성화하기 위해서는 다음과 같은 패키지가 필요하다.</p>
<ul>
<li>Opencensus gRPC 지원 : <code>go.opencensus.io/plugin/ocgrpc</code></li>
<li>Opencensus Trace 지원 : <code>go.opencensus.io/trace</code></li>
</ul>
<p>매트릭을 활성화하기 위해서는 다음과 같은 패키지가 필요하다.</p>
<ul>
<li>서버 핸들러 : <code>go.opencensus.io/plugin/ocgrpc.SserverHandler</code></li>
<li>클라이언트 핸들러 : <code>go.opencensus.io/plugin/ocgrpc.ClientHandler</code></li>
<li>서버 gRPC 측정 항목 보기 : <a href="https://godoc.org/go.opencensus.io/plugin/ocgrpc#DefaultServerViews">https://godoc.org/go.opencensus.io/plugin/ocgrpc#DefaultServerViews</a></li>
<li>클라이언트 gRPC 측정 항목 보기 : <a href="https://godoc.org/go.opencensus.io/plugin/ocgrpc#DefaultClientViews">https://godoc.org/go.opencensus.io/plugin/ocgrpc#DefaultClientViews</a></li>
</ul>
<h3>Protobuf 정의</h3>
<p><code>rpc</code> 폴더를 생성하고 <code>defs.proto</code> 파일에 아래와 같이 정의를 구성한다.</p>
<pre><code>syntax = "proto3";

package rpc;

message Payload {
    int32 id = 1;
    bytes data = 2;
}

service Fetch {
    rpc Capitalize(Payload) returns (Payload) {}
}</code></pre><h3>gRPC 서비스 생성</h3>
<p>정의한 파일을 protoc로 컴파일 한다.</p>
<pre><code># protoc 
$ protoc -I rpc rpc/defs.proto --go_out=plugins=grpc:rpc</code></pre><p>정상적으로 수행되면 <code>defs.pb.go</code> 파일이 생성된다.</p>
<h3>서버 구현</h3>
<p><code>server.go</code>  파일을 생성하고 아래와 같이 구성한다.</p>
<pre><code>package main

import (
    "bytes"
    "context"
    "log"
    "net"
    "google.golang.org/grpc"
    "oc.tutorials/ocgrpc/rpc"
)

type fetchIt int

// Compile time assertion that fetchIt implements FetchServer.
var _ rpc.FetchServer = (*fetchIt)(nil)

func (fi *fetchIt) Capitalize(ctx context.Context, in *rpc.Payload) (*rpc.Payload, error) {
    out :=  &rpc.Payload{
        Data: bytes.ToUpper(in.Data),
    }

return out, nil
}

func main() {
    addr := ":9988"
    ln, err := net.Listen("tcp", addr)
    if nil != err {
        log.Fatalf("gRPC server: failed to listen: %v", err)
    }

srv := grpc.NewServer()
    rpc.RegisterFetchServer(srv, new(fetchIt))

log.Printf("fetchIt gRPC server serving at %q", addr)
    if err := srv.Serve(ln); nil != err {
        log.Fatalf("gRPC server: error serving: %v", err)
    }
}</code></pre><p>이제 실행해서 클라이언트 호출에 대기한다.</p>
<pre><code>$ go run server.go</code></pre><h3>클라이언트 구현</h3>
<p>클라이언트는 gRPC 채널을 통해서 서버와 통신하며 바이트 단위로 전송하고 대문자 처리된 결과를 받게 된다.</p>
<p><code>client.go</code> 파일을 생성하고 아래와 같이 구성한다.</p>
<pre><code>package main

import (
    "bufio"
    "context"
    "fmt"
    "log"
    "os"

"google.golang.org/grpc"
    "oc.tutorials/ocgrpc/rpc"
)

func main() {
    serverAddr := ":9988"
    cc, err := grpc.Dial(serverAddr, grpc.WithInsecure())
    if nil != err {
        log.Fatalf("fetchIt gRPC client failed to dial to server: %v", err)
    }

fc := rpc.NewFetchClient(cc)

fIn := bufio.NewReader(os.Stdin)
    for {
        fmt.Print("> ")
        line, _, err := fIn.ReadLine()
        if nil != err {
            log.Printf("Failed to read a line in: %v", err)
            return
        }

ctx := context.Background()
        out, err := fc.Capitialize(ctx, &rpc.Payload{Data: line})
        if nil != err {
            log.Printf("fetchIt gRPC client got error from server: %v", err)
            continue
        }
        fmt.Printf("< %s\n\n", out.Data)
    }
}</code></pre><p>이제 실행해서 입력한 결과를 확인할 수 있다.</p>
<pre><code>$ go run client.go
> foo
< FOO

> bar
< BAR</code></pre><h2>Instrumentation</h2>
<p>위의 예제에 추적과 매트릭에 대한 계측을 추가한다.</p>
<h3>서버 계측</h3>
<ul>
<li><p><strong>추적</strong></p>
<p>추적을 측정하기 위해서는 grpc.StatsHandler에 ServerHandler를 등록해서 gRPC 측정항목을 추출하고 추적할 수 있도록 추가해 줘야 한다.</p>
<pre><code>import (
  ...
  "go.opencensus.io/trace"
)

func (fi *fetchIt) Capitalize(ctx context.Context, in *rpc.Payload) (*rpc.Payload, error) {
  ctx, span := trace.StartSpan(ctx, "oc.tutorials.grpc.Capitalize")
  defer span.End()

...
}

func main() {
  ...
  srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
  ...
}</code></pre></li>
<li><p><strong>매트릭</strong></p>
<p>매트릭을 측정하기 위해서는 필요한 View 정보를 추가해 줘야 한다.</p>
<pre><code>import (
  ...
  "go.opencensus.io/plugin/ocgrpc"
  "go.opencensus.io/stats/view"
)

func main() {
  ...
  if err := view.Register(ocgrpc.DefaultServerViews...); nil != err {
    log.Fatalf("Failed to register ocgrpc server views: %v", err)
  }

srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
  ...
}</code></pre></li>
<li><p><strong>완성된 최종 서버 코드</strong></p>
<p>추출 및 수집된 데이터를 확인하기 위해서 <code>stackdriver</code>를 Exporter로 등록하는 정보를 추가해 줘야 한다. (Exporter는 다양하므로 선호하는 것을 활용해도 된다)</p>
<pre><code>package main

import (
  "bytes"
  "context"
  "log"
  "net"

"go.opencensus.io/plugin/ocgrpc"
  "go.opencensus.io/stats/view"
  "go.opencensus.io/trace"
  "google.golang.org/grpc"

"oc.tutorials/ocgrpc/rpc"

// The exporter to extract our metrics and traces
  "contrib.go.opencensus.io/exporter/stackdriver"
)

type fetchIt int

// Compile time assertion that fetchIt implements FetchServer.
var _ rpc.FetchServer = (*fetchIt)(nil)

func (fi *fetchIt) Capitalize(ctx context.Context, in *rpc.Payload) (*rpc.Payload, error) {
  ctx, span := trace.StartSpan(ctx, "oc.tutorials.grpc.Capitalize")
  defer span.End()

out := &rpc.Payload{
    Data: bytes.ToUpper(in.Data),
  }
  return out, nil
}

func main() {
  if err := view.Register(ocgrpc.DefaultServerViews...); nil != err {
    log.Fatalf("Failed to register ocgrpc server views: %v", err)
  }

// Create and register the exporter
  sd, err := stackdriver.NewExporter(stackdriver.Options{
    ProjectID:    "census-demos", // Insert your projectID here
    MetricPrefix: "ocgrpctutorial",
  })
  if nil != err {
    log.Fatalf("Failed to create Stackdriver exporter: %v", err)
  }
  defer sd.Flush()
  trace.RegisterExporter(sd)
  sd.StartMetricsExporter()
  defer sd.StopMetricsExporter()
  // For demo purposes let's always sample
  trace.ApplyConfig(trace.Config{DefaultSampler: trace.AlwaysSample()})

addr := ":9988"
  ln, err := net.Listen("tcp", addr)
  if nil != err {
    log.Fatalf("gRPC server: failed to listen: %v", err)
  }
  srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
  rpc.RegisterFetchServer(srv, new(fetchIt))
  log.Printf("fetchIt gRPC server serving at %q", addr)
  if err := srv.Serve(ln); nil != err {
    log.Fatalf("gRPC server: error serving: %v", err)
  }
}</code></pre></li>
</ul>
<h3>클라이언트 계측</h3>
<ul>
<li><p><strong>추적</strong></p>
<p>추적을 측정하기 위해서는 grpc.StatsHandler에 ClientHandler를 등록해서 gRPC 측정항목을 추출하고 추적할 수 있도록 추가해 줘야 한다.</p>
<pre><code>import (
  ...
  "go.opencensus.io/trace"
)

func main() {
  ...
  cc, err := grpc.Dial(serverAddr, grpc.WithInsecure(), grpc.WithStatsHandler(new(ocgrpc.ClientHander)))
  ...
  ctx, span := trace.StartSpan(context.Background(), "oc.tutorials.grpc.ClientCapitalize")
  out, err := fc.Capitalize(ctx, &rpc.Payload{Data: line})
  if nil != err {
    span.SetStatus(trace.Status{Code: trace.StatusCodeInternal, Message: err.Error()})
    log.Printf("fetchIt gRPC client got error from server: %v", err)
  } else {
    fmt.Printf("< %v\n\n", out.Data)
  }
  span.End()
  ...
}</code></pre></li>
<li><p><strong>매트릭</strong></p>
<p>매트릭을 측정하기 위해서는 필요한 View 정보를 추가해 줘야 한다.</p>
<pre><code>import (
  ...
  "go.opencensus.io/plugin/ocgrpc"
  "go.opencensus.io/stats/view"
  "go.opencensus.io/trace"
)

func main() {
  ...
  if err := view.Register(ocgrpc.DefaultClientViews...); nil != err {
    log.Fatalf("Failed to register ocgrpc client views: %v", err)
  }
  cc, err := grpc.Dial(serverAddr, grpc.WithInsecure(), grpc.WithStatsHandler(new(ocgrpc.ClientHander)))
}</code></pre></li>
<li><p><strong>완성된 클라이언트 코드</strong></p>
<p>추출 및 수집된 데이터를 확인하기 위해서 <code>stackdriver</code>를 Exporter로 등록하는 정보를 추가해 줘야 한다. (Exporter는 다양하므로 선호하는 것을 활용해도 된다)</p>
<pre><code>package main

import (
  "bufio"
  "context"
  "fmt"
  "log"
  "os"

"go.opencensus.io/plugin/ocgrpc"
  "go.opencensus.io/stats/view"
  "go.opencensus.io/trace"
  "google.golang.org/grpc"

"oc.tutorials/ocgrpc/rpc"

// The exporter to extract our metrics and traces
  "contrib.go.opencensus.io/exporter/stackdriver"
)

func main() {
  if err := view.Register(ocgrpc.DefaultClientViews...); nil != err {
    log.Fatalf("Failed to register ocgrpc client views: %v", err)
  }

serverAddr := ":9988"
  cc, err := grpc.Dial(serverAddr, grpc.WithInsecure(), grpc.WithStatsHandler(new(ocgrpc.ClientHandler)))
  if nil != err {
    log.Fatalf("fetchIt gRPC client failed to dial to server: %v", err)
  }
  fc := rpc.NewFetchClient(cc)

fIn := bufio.NewReader(os.Stdin)
  for {
    fmt.Print("> ")
    line, _, err := fIn.ReadLine()
    if nil != err {
      log.Printf("Failed to read a line in: %v", err)
      return
    }

ctx, span := trace.StartSpan(context.Background(), "oc.tutorials.grpc.ClientCapitalize")
    out, err := fc.Capitalize(ctx, &rpc.Payload{Data: line})
    if nil != err {
      span.SetStatus(trace.Status{Code: trace.StatusCodeInternal, Message: err.Error()})
      log.Printf("fetchIt gRPC client got error from server: %v", err)
    } else {
      fmt.Printf("< %s\n\n", out.Data)
    }
    span.End()
  }
}</code></pre></li>
</ul>
<h2>Example Traces</h2>
<p>GCP와 연계를 했고 stackdriver를 선택해서 추적 정보를 Export 했다면 <a href="https://console.cloud.google.com/traces/traces">Goolgle Cloud Platform Trace 정보</a> 를 통해서 처리된 작업을 확인할 수 있다.</p>
<h2>Example Metrics</h2>
<p>GCP와 연계를 했고 stackdriver를 선택해서 매트릭 정보를 Export 했다면 <a href="https://console.cloud.google.com/monitoring">Google Cloud Platform Metrics 정보</a> 를 통해서 처리된 작업을 확인할 수 있다.</p>
<h2>참고 자료</h2>
<ul>
<li><a href="https://opencensus.io/guides/grpc/go/">OpenCensus</a></li>
</ul>

MSFL :: 모리스 소프트웨어 공작소

이 블로그 검색

[OpenCensus - Trace] Opencensus를 이용한 gRPC Trace 와 Metrics 처리하기

태그

댓글

댓글 쓰기

이 블로그의 인기 게시물

OData 에 대해서 알아보자.

C# 에서 Timer 사용할 때 주의할 점.

[Logging] NLog 사용법 정리...