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

/ m# a/ g9 B6 N. p7 O# R0 y/ h

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

' f# L9 o( n/ N; X+ H

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

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

* x7 E) H# _& ]3 w: B

通过本文你将了解：

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

4 }; |7 w9 M3 v" z; f! W5 E; \

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

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

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

9 J( p+ j) W8 k+ p+ a$ i6 h; |

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

( H/ G. L6 J3 ~

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

r3 D# Z, a" a7 e

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

& e# ]0 d/ j, d: w/ i

下载并体验样例

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

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

cd prometheus-exemplar

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

/ @9 ?3 [4 ^& D, H

docker-compose up -d

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

/ B' r* `0 N. h' W& ?

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

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

$ J) x/ `2 I& F+ z; W

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

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

* W- Z" Q) L u* I3 K- P% r+ B

整个部署架构如下：

- s) W9 t+ _3 U( Q- d6 _+ ^

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

. q7 W! w& g v" j7 q. f

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

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

2 S" Y5 ^' K: N; m

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

2 L" q0 k+ X, W/ [- J6 N

2 x. r( e; @& d/ z0 r3 u+ E

细节说明

3 S8 }/ t4 [) I# f

使用 Promethues Go SDK 导出 metrics

在 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",

Help: "Http latency distributions.",

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

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

prometheus.MustRegister(httpDurationsHistogram)

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

( y1 X0 o$ b, x' I

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

observer.Observe(elapsed)

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

})

}

}

}

. x3 ?5 `1 G0 @; a* U, G

使用 OTLP HTTP 导出 traces

. O! `0 o- t0 Q2 @' N& O* r

使用 OTel SDK 进行 trace 埋点：

1 V, Q+ k8 W0 ^# A

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

( T/ {) P. G5 T* W( s

defer span.End()

// mysql qury random time duration

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

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

9 q3 U7 P/ J4 V9 ~# x, ?

return

}

! Q! e) U5 H. ]* G2 n

使用 OLTP HTTP 进行导出：

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

client := otlptracehttp.NewClient(

otlptracehttp.WithEndpoint(endpoint),

otlptracehttp.WithInsecure(),

; h( L& ^- i2 K" |2 g

)

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

if err != nil <{p> return err

3 m9 X3 L0 o+ w' B1 o( V c3 c7 [

}

tp := tracesdk.NewTracerProvider(

9 f- w- j& \1 m$ P' H# a

tracesdk.WithBatcher(exp),

" g2 [$ C# k5 {+ ^- F, N+ d4 F3 Q

tracesdk.WithResource(resource.NewWithAttributes(

semconv.SchemaURL,

semconv.ServiceNameKey.String(serviceName),

5 w* O) H( l$ _0 {; i6 q

attribute.String("environment", environment),

)),

)

8 K" c# b1 x" }# }7 E( w2 X! V; A

otel.SetTracerProvider(tp)

return nil

; ^6 q( p9 c2 W, q( V

}

结构化日志

" N) R6 G6 |3 T1 S) p4 A

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

cfg := zap.NewProductionConfig()

2 d# i1 \2 W+ z6 h; v+ k

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

8 R3 J- t& N2 h

logger, _ := cfg.Build()

) b4 T( N! l* a

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

使用 OTel Collector 进行 metric、trace 收集

) j# B2 C/ J8 b1 ?

因为 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:

+ N0 q' t9 @: j) z

protocols:

3 ^0 Q2 J. B$ s3 [9 l' y

grpc:

: |& j Q1 T8 Y* j6 \9 S

http:

prometheus:

config:

scrape_configs:

- job_name: app

* V1 P' i: D3 E6 K/ P% B8 r1 W

scrape_interval: 10s

; p% y+ k) Z) b4 @3 Q

static_configs:

- targets: [app:8080]

exporters:

# m: u2 l/ z1 ]4 _0 n; }5 F: S

otlp:

0 r; f4 \' N' o

endpoint: tempo:4317

tls:

insecure: true

@- Q1 ?7 Q# R! W% r; R0 m) G8 }, a

prometheusremotewrite:

( U- F% s& r9 X9 l+ A" f8 ]

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

tls:

: }- w% C$ D- M/ O1 V

insecure: true

7 c: b, F* p2 W4 z

headers:

! `! K/ `% j# Y! i

X-Scope-OrgID: demo

processors:

batch:

/ s( X* h4 D8 w3 G1 c

service:

pipelines:

traces:

receivers: [otlp]

1 \7 x+ E; C" I* A$ d% P" v# T

processors: [batch]

( o9 n+ j: m0 v

exporters: [otlp]

metrics:

receivers: [prometheus]

* W- y% E6 W% D" w+ s. K' x

processors: [batch]

; x- B2 Z! N: q/ E, d: n

exporters: [prometheusremotewrite]

6 W/ u( \/ f# l" I9 U7 X3 @% P7 W

使用 OTel Collector Contrib 进行 log 收集

! H' v) F9 X6 ]

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

* Z1 o9 f1 K* Q9 ^

receivers:

) u- x, I' I7 H& `- K

filelog:

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

8 N+ V. z0 X k0 u- f, L

exporters:

' @+ M$ T2 N1 l- _/ J% e, K& h

loki:

$ t8 w/ h, y" F. d0 A9 O. _% z7 O7 C

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

* N* ]5 S3 P# G; _! v) d, X

tenant_id: demo

H$ v) A5 e1 c1 p. Q+ B

labels:

5 T, ~: E' }) i* Y' l

attributes:

log.file.name: "filename"

processors:

- V8 |5 h S, K7 j1 h/ Y! k8 u) x8 i

batch:

* j' v9 S: R6 P3 ]$ H% f: }, T

service:

pipelines:

logs:

receivers: [filelog]

processors: [batch]

exporters: [loki]

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

总结

) L/ O: H) X+ P( y; D4 B8 k% { Y

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

; S8 f# }5 w! R# ]

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

责任编辑：

+ R0 ~$ g& b+ L4 J ) ~& {& v4 w) x0 s3 Q