기본 콘텐츠로 건너뛰기

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

Opencensus를 이용한 gRPC Global Tracing

Overview

Opencensus를 사용해서 시스템의 추적 및 매트릭을 수집하고 선택한 백엔드로 내보내 분산 시스템에 대한 관찰성을 제공할 수 있다.

간단하게 gRPC 상에서 추적을 검증하기 위한 용도이므로 단순히 바이트를 포함하는 페이로드를 받아서 대문자 처리를 하는 서비스를 대상으로 검토해 보도록 한다.

Requirements

Creating our gRPC Service

추적을 활성화하기 위해서는 다음과 같은 패키지가 필요하다.

  • Opencensus gRPC 지원 : go.opencensus.io/plugin/ocgrpc
  • Opencensus Trace 지원 : go.opencensus.io/trace

매트릭을 활성화하기 위해서는 다음과 같은 패키지가 필요하다.

Protobuf 정의

rpc 폴더를 생성하고 defs.proto 파일에 아래와 같이 정의를 구성한다.

syntax = "proto3";

package rpc;


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


service Fetch {
rpc Capitalize(Payload) returns (Payload) {}
}

gRPC 서비스 생성

정의한 파일을 protoc로 컴파일 한다.

# protoc 
$ protoc -I rpc rpc/defs.proto --go_out=plugins=grpc:rpc

정상적으로 수행되면 defs.pb.go 파일이 생성된다.

서버 구현

server.go 파일을 생성하고 아래와 같이 구성한다.

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)
}



}

이제 실행해서 클라이언트 호출에 대기한다.

$ go run server.go

클라이언트 구현

클라이언트는 gRPC 채널을 통해서 서버와 통신하며 바이트 단위로 전송하고 대문자 처리된 결과를 받게 된다.

client.go 파일을 생성하고 아래와 같이 구성한다.

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)
}



}

이제 실행해서 입력한 결과를 확인할 수 있다.

$ go run client.go
> foo
< FOO

> bar
< BAR

Instrumentation

위의 예제에 추적과 매트릭에 대한 계측을 추가한다.

서버 계측

  • 추적

    추적을 측정하기 위해서는 grpc.StatsHandler에 ServerHandler를 등록해서 gRPC 측정항목을 추출하고 추적할 수 있도록 추가해 줘야 한다.

    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{}))
…
}

  • 매트릭

    매트릭을 측정하기 위해서는 필요한 View 정보를 추가해 줘야 한다.

    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{}))
…
}

  • 완성된 최종 서버 코드

    추출 및 수집된 데이터를 확인하기 위해서 stackdriver를 Exporter로 등록하는 정보를 추가해 줘야 한다. (Exporter는 다양하므로 선호하는 것을 활용해도 된다)

    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)
}
}

클라이언트 계측

  • 추적

    추적을 측정하기 위해서는 grpc.StatsHandler에 ClientHandler를 등록해서 gRPC 측정항목을 추출하고 추적할 수 있도록 추가해 줘야 한다.

    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()
…
}

  • 매트릭

    매트릭을 측정하기 위해서는 필요한 View 정보를 추가해 줘야 한다.

    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)))
}

  • 완성된 클라이언트 코드

    추출 및 수집된 데이터를 확인하기 위해서 stackdriver를 Exporter로 등록하는 정보를 추가해 줘야 한다. (Exporter는 다양하므로 선호하는 것을 활용해도 된다)

    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)
}
    

    // 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()})
    

    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()

    

    }
}

Example Traces

GCP와 연계를 했고 stackdriver를 선택해서 추적 정보를 Export 했다면 Goolgle Cloud Platform Trace 정보 를 통해서 처리된 작업을 확인할 수 있다.

Example Metrics

GCP와 연계를 했고 stackdriver를 선택해서 매트릭 정보를 Export 했다면 Google Cloud Platform Metrics 정보 를 통해서 처리된 작업을 확인할 수 있다.

참고 자료

태그

라벨:

댓글

댓글 쓰기

이 블로그의 인기 게시물

OData 에 대해서 알아보자.

얼마 전에 어떤 회사에 인터뷰를 하러 간 적이 있었다. 당시 그 회사는 자체 솔루션을 개발할 기술인력을 찾고 있었고 내부적으로 OData를 사용한다고 했다. 좀 창피한 이야기일 수도 있지만 나름 기술적인 부분에서는 많은 정보를 가지고 있다고 했던 것이 무색하게 OData란 단어를 그 회사 사장님에게서 처음 들었다. 작고, 단순한 사이트들만을 계속해서 작업을 하다 보니 어느덧 큰 줄기들을 잃어버린 것을 느끼기 시작했다. 명색이 개발이 좋고, 기술적인 기반을 만들려고 하는 인간이 단어조차도 모른다는 것은 있을 수 없는 것이라서 다시 새로운 단어들과 개념들을 알아보는 시간을 가지려고 한다. OData (Open Data Protocol) 란? 간단히 정리하면 웹 상에서 손쉽게 데이터를 조회하거나 수정할 수 있도록 주고 받는 웹(프로토콜)을 말한다. 서비스 제공자 입장에서는 웹으로 데이터를 제공하는 방식으로 각 포탈 사이트들이 제공하는 OPEN API 포맷을 독자적인 형식이 아니라 오픈된 공통규약으로 제공 가능하며, 개발자는 이 정보를 다양한 언어의 클라이언트 라이브러리로 어플리케이션에서 소비할 수 있도록 사용하면 된다. 공식 사이트는 www.odata.org 이며 많은 언어들을 지원하고 있다. 좀더 상세하게 정의를 해 보면 OData는 Atom Publishing Protocol  (RFC4287) 의 확장 형식이고 REST (REpresentational State Transfer) Protocol 이다. 따라서 웹 브라우저에서 OData 서비스로 노출된 데이터를 볼 수 있다. 그리고 AtomPub 의 확장이라고 했듯이 데이터의 조회만으로 한정되는 것이 아니라 CRUD 작업이 모두 가능하다. Example 웹 브라우저에서 http://services.odata.org/website/odata.svc 를 열어 보도록 하자. This XML file does not appear to have any style in...
댓글 6개
자세한 내용 보기

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

예전에 알고 지내시던 분의 질문을 받았다. Windows Forms 개발을 하는데, 주기적 (대략 1분)으로 데이터 요청을 하는 프로그램을 작성하기 위해서 Timer 를 사용하는데, 어떤 기능을 처리해야 하기 때문에 Sleep 을 같이 사용했다고 한다. 여기서 발생하는 문제는 Sleep 5초를 주었더니, Timer 까지 5초 동안 멈춘다는 것이다. Timer 라는 것은 기본적으로 시간의 흐름을 측정하는 기능이기 때문에 Sleep 을 했다고 해서 Timer 가 멈추는 일은 생겨서는 안된다. 그러나 실제 샘플을 만들어 보면 ... Timer 가 Sleep 만큼 동작이 멈추는 것을 확인할 수 있다. Windows Forms 는 UI Thread 를 사용하는 것으로 최적화 되어 있으며 여기서 Timer 를 쓰면 UI Thread 에 최적화된 System.Windows.Forms.Timer 가 사용된다. 여기서 문제의 발생이 시작되는 것이다. Sleep 을 사용하게 되면 UI Thread 가 Sleep 이 걸리기 때문에 여기에 속한 Timer 까지도 멈추는 것이다. 이런 문제를 해결하기 위해서는 System.Threading.Timer 를 사용해야 한다. 이 Timer 는 별도의 Thread 에서 동작하기 때문에 Sleep 의 영향을 받지 않는다. 언뜻 보면 쉬운 해결 방법인 것 같지만 Thread 가 분리되었기 때문에 Timer 가 돌아가는 Thread 에서 UI Thread 의 메서드나 컨트롤에 접근하기 위해서는 별도의 명령을 사용해야 하는 문제가 존재한다. 자~ 그럼 여기서 Timer 에 대해서 다시 한번 정리해 보도록 하자. .NET 에서 제공하는 Timer 들 .NET 에서는 기본적으로 3가지 Timer를 제공하고 있다. (MSDN) System.Windows.Forms.Timer - 사용자가 지정한 간격마다 이벤트를 발생시키며 Windows Forms 응용 프로그램에서 사용할 수 있도록 최적화 되어 있다. System...
댓글 7개
자세한 내용 보기

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

SCSF 에는 기본적으로 Enterprise Library가 사용된다. 예전에도 그랬지만 기능은 훌륭하고 많은 부분에서 최적화(?)된 것일지도 모르지만, 역시나 사용하기에는 뭔가 모르게 무겁고, 사용하지 않는 기능이 더 많다라는 느낌을 지울수가 없다. 이번 프로젝트도 SCSF를 기반으로 하고 있지만, Enterprise Library를 걷어내고 각 부분에 전문화된 오픈 소스를 사용하기로 하였다. 예전에는 Log4Net을 사용했지만, 대량 사용자 환경에서는 메모리 누수와 기타 문제점이 존재한다는 MS 컨설턴트(?)의 전해진 말을 들은 후로는 사용하지 않는다. 대안으로 사용하는 것이 NLog 이다. 조금 후에는 3.0 버전도 나온다고 홈 페이지에 기재되어 있지만, 그 때가 되면 프로젝트는 끝나기 때문에 현재 2.1.0 버전을 사용하기로 했다. [원본 출처] http://cloverink.net/most-useful-nlog-configurations-closed/ 위의 참조 자료에는 다양한 정보들이 존재하므로 꼭 링크를 통해서 관련된 정보를 확인하고 이해하는 것이 좋을 듯 하다. 여기서는 당장 필요한 부분만을 정리하도록 한다. [ Logger 찾기 ] 기본적으로 Logger가 존재하는 클래스를 기반으로 Logger 정보를 구성한다. Logger logger = LogManager.GetCurrentClassLogger(); 주로 Namespace 기반으로 Logger를 설정하는 경우에 유연하게 사용할 수 있다. 또 다른 방법으로는 지정한 문자열로 특정 Logger를 직접 선택하는 방법도 제공된다. 이를 혼용해서 Namespace와 직접 지정 방식을 같이 사용할 수도 있다. 물론 Logger 환경 설정에서 Wildcard (*)를 지정할 수도 있다. Logger logger = LogManager.GetLogger("Database.Connect"); Logger logger = LogManager.Get...
댓글 1개
자세한 내용 보기