原创 基于 Grafana LGTM 可观测平台的构建

原标题：基于 Grafana LGTM 可观测平台的构建

\1 T& c8 W% j2 {4 b; ? 5 e# G+ A h. t

可观测性目前属于云原生一个比较火的话题，它涉及的内容较多，不仅涉及多种遥测数据（信号），例如日志（log）、指标(metric)、分布式追踪（trace）、连续分析(continuous profiling)、 事件（event）；还涉及遥测数据各生命周期管理，比如暴露、采集、存储、计算查询、统一看板。

目前社区相关开源产品较多，各有各的优势，今天我们就来看看如何使用 Grafana LGTM 技术栈（Grafana、Loki、Tempo、Mimir）快速构建一个自己的可观测性平台。

3 l* F7 N6 r6 j y: B8 _

通过本文你将了解：

, V/ t- O. [- h( M8 [. p. S

如何在 Go 程序中导出 metric、trace、log、以及它们之间的关联 TraceID

1 W; } P( |, K5 w; U: |

如何使用 OTel Collector 进行 metric、trace 收集

如何使用 OTel Collector Contrib 进行日志收集

如何部署 Grafana Mimir、Loki、Tempo 进行 metric、trace、log 数据存储

如何使用 Grafana 制作统一可观测性大盘

为了本次的教学内容，我们提前编写了一个 Go Web 程序，它提供 /v1/books 和 /v1/books/1 两个 HTTP 接口。

" G1 J7 V% ~8 {# S0 m8 k2 u

当请求接口时，会先访问 Redis 缓存，如果未命中将继续访问 MySQL；整个请求会详细记录相关日志、整个链路各阶段调用情况以及整体请求延迟，当请求延迟 >200ms 时，会通过 Prometheus examplar 记录本次请求的 TraceID，用于该请求的日志、调用链关联。

7 F& W# L2 L3 a" r9 c; @

下载并体验样例

6 ^& |' B7 N4 F& O

我们已经提前将样例程序上传到 github，所以您可以使用 git 进行下载：

" J! {% g E8 v, u( t0 {5 b

git clone https://github.com/grafanafans/prometheus-exemplar.git

cd prometheus-exemplar

1 u0 M' N- W1 ]) N$ w2 ~

使用 docker-compose 启动样例程序:

docker-compose up -d

这个命令会启动以下程序：

使用单节点模式分别启动一个 Mimir、Loki、Tempo

8 r) w8 y" x3 {$ X7 H0 N

启动一个 Nginx 作为统一可观测平台查询入口，后端对接 Mimir、Loki、Tempo

" D# P: J6 M+ F+ ?

启动 demo app, 并启动其依赖的 MySQL 和 Redis， demo app 可以使用 http://localhost:8080 访问

# I/ u) h3 C# _: q

启动 Grafana 并导入预设的数据源和 demo app 统一看板，可以使用 http://localhost:3000 访问

# j2 Q f" `5 V

整个部署架构如下：

当程序部署完成后，我们可以使用 wrk 进行 demo app 接口批量请求：

# E: H5 `+ G C9 F

wrk http://localhost:8080/v1/books

wrk http://localhost:8080/v1/books/1

最后通过 http://localhost:3000 页面访问对应的看板：

细节说明

使用 Promethues Go SDK 导出 metrics

6 s8 J1 p7 i1 g! Z; z7 V

在 demo app 中，我们使用 Prometheus Go SDK 作为 metrics 导出，这里没有使用 OpenTelmetry SDK 主要因为当前版本（v0.33.0）还不支持 exemplar， 代码逻辑大致为：

func Metrics(metricPath string, urlMapping func(string) string) gin.HandlerFunc <{p> httpDurationsHistogram := prometheus.NewHistogramVec(prometheus.HistogramOpts<{p> Name: "http_durations_histogram_seconds",

* U- w) w+ r& ?& m8 h

Help: "Http latency distributions.",

Buckets: []float64{0.05, 0.1, 0.25, 0.5, 1, 2},

}, []string{"method", "path", "code"})

/ \: v/ t- d8 g% c# B1 h: q; }

prometheus.MustRegister(httpDurationsHistogram)

! C3 S8 b( h$ j$ \ n! b2 f @: ^

return func(c *gin.Context) <{p> .....

observer := httpDurationsHistogram.WithLabelValues(method, url, status)

observer.Observe(elapsed)

& P. W; _" t" M: v

if elapsed > 0.2 <{p> observer.(prometheus.ExemplarObserver).ObserveWithExemplar(elapsed, prometheus.Labels<{p> "traceID": c.GetHeader(api.XRequestID),

7 P$ k* ] B/ z9 y/ V6 `1 v

})

}

4 D; ?- G, S# V7 v! [

}

1 M' Q6 d1 Z2 {2 f6 A; o/ Q

}

使用 OTLP HTTP 导出 traces

7 P4 H! _/ k7 _5 C; t! v

使用 OTel SDK 进行 trace 埋点：

func (*MysqlBookService) Show(id string, ctx context.Context) (item *Book, err error) <{p> _, span := otel.Tracer().Start(ctx, "MysqlBookService.Show")

span.SetAttributes(attribute.String("id", id))

( O1 k7 | b2 |$ a) L; F$ j

defer span.End()

$ l8 V/ k2 _4 O5 }; ?6 \$ m

// mysql qury random time duration

time.Sleep(time.Duration(rand.Intn(250)) * time.Millisecond)

err = db.Where(Book{Id: id}).Find(&item).Error

return

; D# \9 I, z# a6 ] N

}

# \4 f) t- C$ T+ `; A

使用 OLTP HTTP 进行导出：

( d& [5 ~$ ~, t# r8 P

func SetTracerProvider(name, environment, endpoint string) error <{p> serviceName = name

client := otlptracehttp.NewClient(

& X6 `* B6 q( w) r) T

otlptracehttp.WithEndpoint(endpoint),

+ C5 { G. a0 y5 x C! n

otlptracehttp.WithInsecure(),

' j5 o: e) ^/ L: w( G; a( u4 ]

)

" }+ _+ g @0 p. ?' o# y

exp, err := otlptrace.New(context.Background(), client)

if err != nil <{p> return err

* s9 h' B( z) I U2 t2 l3 t i* Y+ w

}

tp := tracesdk.NewTracerProvider(

- ~3 b. T7 A3 V% t7 w

tracesdk.WithBatcher(exp),

tracesdk.WithResource(resource.NewWithAttributes(

2 d1 T ~; J( ^& M2 L

semconv.SchemaURL,

semconv.ServiceNameKey.String(serviceName),

attribute.String("environment", environment),

3 |3 N/ E( X* I9 Z2 Z. j& R) e0 [

)),

/ E9 h( M3 c4 }: ^: c

)

otel.SetTracerProvider(tp)

7 Y- T$ o2 A' x# P3 |4 B

return nil

}

结构化日志

这里我们使用 go.uber.org/zap 包进行结构化日志输出，并输出到 /var/log/app.log 文件，每个请求开始时，注入 traceID：

cfg := zap.NewProductionConfig()

% G# E, ?) }7 W" ]2 Y% P( C& ?

cfg.OutputPaths = []string{"stderr", "/var/log/app.log"}

8 G! j d j# L) c1 h# g

logger, _ := cfg.Build()

logger.With(zap.String("traceID", ctx.GetHeader(XRequestID)))

4 O( P% J' j' @( h: d3 h: f2 n

使用 OTel Collector 进行 metric、trace 收集

因为 demo app 的 metrics 使用 Prometheus SDK 导出，所以 OTel Collector 需要使用 Prometheus recevier 进行抓取，然后我们再通过 Prometheus remotewrite 将数据 push 到 Mimir。

针对 traces，demo app 使用 OTLP HTTP 进行了导出，所有 Collector 需要用 OTP HTTP recevier 进行接收，最后再使用 OTLP gRPC 将数据 push 到 Tempo，对应配置如下：

receivers:

otlp:

6 G4 m# z1 n9 q- f# d

protocols:

. |2 G1 X# W- B/ T

grpc:

8 X; s" l3 i3 u1 S0 e6 B2 l

http:

prometheus:

2 p) j* O6 |8 L: q1 m3 N3 E8 v

config:

scrape_configs:

- job_name: app

scrape_interval: 10s

static_configs:

4 X% b% Q% J7 `( _7 V

- targets: [app:8080]

1 o8 p2 k, m& s. z8 O3 L' }

exporters:

otlp:

endpoint: tempo:4317

q: l8 p. z6 [5 p3 f6 j

tls:

insecure: true

prometheusremotewrite:

endpoint: http://mimir:8080/api/v1/push

tls:

# X* c) p% [2 U

insecure: true

headers:

X-Scope-OrgID: demo

. r) I' i5 V4 G

processors:

batch:

( _3 r# e9 V9 R6 O

service:

7 U' ?' B' @2 `2 ^

pipelines:

0 g- s1 C& x$ r+ B4 P

traces:

receivers: [otlp]

1 H' l- h0 ^. c% a% d* N/ R

processors: [batch]

exporters: [otlp]

metrics:

receivers: [prometheus]

) p; A* `) `: }' x0 P

processors: [batch]

exporters: [prometheusremotewrite]

使用 OTel Collector Contrib 进行 log 收集

6 I# b' g# Z" l* G$ B1 M" D

因为我们结构化日志输出到了/var/log/app.log 文件，所以这里使用 filelog receiver 进行最新日志读取，最后再经过loki exporter 进行导出，配置如下：

receivers:

filelog:

include: [/var/log/app.log]

9 `* Y& \8 g. B3 L [

exporters:

' k) X% t |5 b( ~( y& R# Q0 E

loki:

& G ]" ^ a8 W8 T

endpoint: http://loki:3100/loki/api/v1/push

4 X ~( ] g1 I7 x+ r( k& |% |

tenant_id: demo

. ^- @0 I$ c- o% Z

labels:

9 r5 `6 }$ z; U' U

attributes:

# [7 |0 L5 B) \9 f/ h! T+ y4 s

log.file.name: "filename"

processors:

; l' n( t+ M. o; o" L2 g0 t0 u

batch:

service:

pipelines:

logs:

9 A) s! G# W q3 D( J% N2 f

receivers: [filelog]

processors: [batch]

exporters: [loki]

以上就是有关 demo app 可观测性与 Grafana LGTM 技术栈集成的核心代码与配置，全部配置请参考 https://github.com/grafanafans/prometheus-exemplar 。

总结

本文我们通过一个简单的 Go 程序，导出了可观测性相关的遥测数据，其中包括 metrics、traces、logs, 然后统一由 OTel Collector 进行抓取，分别将三种遥测数据推送到 Grafana 的 Mimir、 Tempo、Loki 进行存储，最后再通过 Grafana 统一看板并进行 metrics、traces、logs 关联查询。

这里关联的逻辑为使用 Prometheus 的 exemplar 记录采样对应的 traceID，然后通过该 traceID 进行相关日志和 trace 查询。返回搜狐，查看更多

4 d3 Z4 T; r4 r G9 n1 C! j 8 j! d2 o& P& ^1 q9 H( P, ~

责任编辑：

2 p7 }5 t3 W" b' j7 j' }$ c0 c - R% i) U# L1 h- L0 ~- Q