本站首页 收藏本站
广告位联系

APP正在开发中...
返回顶部
您的位置： 主页 > 脚本 > Golang >

收藏
分享到

OpenTelemetry-go的SDK使用方法介绍

Golang 来源：互联网 作者：佚名 发布时间：2022-09-26 20:57:56 人浏览
摘要

2019年5月,OpenCensus 和 OpenTracing形成了 OpenTelemetry(简称 OTel) 也就是说,我们在使用链路追踪SDK的时候就需要使用OpenTelemetry的新规范.OpenTelemetry帮我们实现了相应语言的SDK,所以我们只需要进

2019年5月,OpenCensus 和 OpenTracing形成了 OpenTelemetry(简称 OTel)

也就是说,我们在使用链路追踪SDK的时候就需要使用OpenTelemetry的新规范.OpenTelemetry帮我们实现了相应语言的SDK,所以我们只需要进行调用即可.
接下来,我们开始对go所对应的SDK进行使用.

本文主要根据官方文档实例进行讲解.

例子

本文简化了官方的例子,每个地方都已注释完毕! 例子使用jaeger作为链路追踪服务器.

首先我们先引入它的包.

1

2

3

4

5

6

7

8

# 安装核心模块

go get go.opentelemetry.io/otel \

       go.opentelemetry.io/otel/trace

# 安装导出器,这里导出器使用的是stdout

go get go.opentelemetry.io/otel/sdk \

         go.opentelemetry.io/otel/exporters/stdout/stdouttrace

# 因为我们需要使用jaeger所以要导入jaeger导出器

go get -u go.opentelemetry.io/otel/exporters/jaeger

当我们导入上面的包之后,就可以运行例子了.

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

package main

import (

    "context"

    "fmt"

    "go.opentelemetry.io/otel"

    "go.opentelemetry.io/otel/attribute"

    "go.opentelemetry.io/otel/exporters/jaeger"

    "go.opentelemetry.io/otel/sdk/resource"

    "go.opentelemetry.io/otel/sdk/trace"

    semconv "go.opentelemetry.io/otel/semconv/v1.12.0"

)

// 计算斐波那契队列

func Fibonacci(n uint) (uint64, error) {

    if n <= 1 {

        return uint64(n), nil

    }

 

    var n2, n1 uint64 = 0, 1

    for i := uint(2); i < n; i++ {

        n2, n1 = n1, n1+n2

    }

 

    return n2 + n1, nil

}

// 这里模拟服务之间的掉用的效果.

func Run(ctx context.Context) {

    _, span := otel.Tracer("nihao").Start(ctx, "two")

    defer span.End()

    fibonacci, err := Fibonacci(20)

    if err != nil {

        return

    }

    fmt.Println(fibonacci)

}

// newExporter returns a console exporter.

// 创建导出器,对于链路追踪服务器的选择就是在这里配置

// 下面是基于jaeger的导出器.

// 这里需要注意,在使用jaeger导出器的时候传输格式是jaeger.thrift over HTTP

// 所以在配置url时请使用14268端口 与/api/traces

func newExporter(url string) (*jaeger.Exporter, error) {

    return jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url)))

}

 

// 资源是一种特殊类型的属性，适用于进程生成的所有跨度。这些应该用于表示有关非临时进程的底层元数据

// 例如，进程的主机名或其实例 ID

func newResource() *resource.Resource {

    r, _ := resource.Merge(

        resource.Default(),

        resource.NewWithAttributes(

            semconv.SchemaURL,

            semconv.ServiceNameKey.String("fib"),

            semconv.ServiceVersionKey.String("v0.1.0"),

            attribute.String("environment", "demo"),

        ),

    )

    return r

}

 

// 主函数

func main() {

    url := "http://collector.tl.com:31498/api/traces"

    // 创建导出器

    exp, _ := newExporter(url)

    // 创建链路生成器,这里将导出器与资源信息配置进去.

    tp := trace.NewTracerProvider(

        trace.WithBatcher(exp),

        trace.WithResource(newResource()),

    )

    // 结束时关闭链路生成器

    defer func() {

        if err := tp.Shutdown(context.Background()); err != nil {

            fmt.Println(err)

        }

    }()

 

    // 将创建的生成器设置为全局变量.

    // 这样直接使用otel.Tracer就可以创建链路.

    // 否则 就要使用 tp.Tracer的形式创建链路.

    otel.SetTracerProvider(tp)

    newCtx, span := otel.Tracer("nihao").Start(context.Background(), "one")

    Run(newCtx)

    span.End()

}

原理

运行成功了,那么它的底层原理是怎么实现的,每个组件是怎么组织的?
这里我将根据上面的例子画一张流程图来进行说明.

通过上面的图我们可以知道,跨度之间的传输使用的是Context 来实现的.
使用span.end()就是将当前跨度信息发送给链路追踪服务器.

方法使用

接下来让我们根据上面的例子讲解一下他们每个方法的使用方式与配置吧!

newExporter

它的作用是创建一个导出器
在里面有两种配置

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

// 配置jaeger服务器

jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url))

// 参数是一个options ...CollectorEndpointOption所以让我们看一下都有哪些配置

jaeger.WithEndpoint(endpoint string) // 配置服务器地址

jaeger.WithUsername(username string) // 配置用户名

jaeger.WithPassword(password string) // 配置密码

jaeger.WithHTTPClient(client *http.Client) //设置用于发送给jeager服务器所用到的client,有默认.这里可以设置

 

// 配置jaeger-agent 代理地址

jaeger.WithAgentEndpoint()

// 参数是options ...AgentEndpointOption

jaeger.WithAgentHost(host string) // 设置代理host

jaeger.WithAgentPort(port string) // 设置代理端口

jaeger.WithLogger(logger *log.Logger) // 设置日志系统

jaeger.WithDisableAttemptReconnecting() // 设置禁止重新连接UDP

jaeger.WithAttemptReconnectingInterval(interval time.Duration) // 设置代理解析jaeger服务器之间的时间间隔

jaeger.WithMaxPacketSize(size int) // 设置UDP传输的最大包

无论是使用agent还是Collector,导出器都 使用batchUploader,也就是批量上传策略.

newResource

存在于每个span中,在jaegerUI上显示的是tag下面的Process
它有默认设置,也可以自定义,下面让我们看一下具体使用

1

2

3

4

5

6

7

8

9

10

11

12

13

// merge 只是合并下面的两组资源.

r, _ := resource.Merge(

        // 设置默认的资源. 进程id等

        resource.Default(),

        // 设置自定义属性

        resource.NewWithAttributes(

            semconv.SchemaURL,

            semconv.ServiceNameKey.String("fib"),

            semconv.ServiceVersionKey.String("v0.1.0"),

            // 我们可以使用该方法,来进行添加自定义属性

            attribute.String("environment", "demo"),

        ),

    )

这里并不强制使用resource.NewWithAttributes,只要返回值是 resource.Resource 即可

trace.NewTracerProvider

创建一个链路生成器,我们主要使用它来进行链路追踪

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

    // 创建生成器,这里配置了资源与 导出器.

tp := trace.NewTracerProvider(

        trace.WithBatcher(exp),

        trace.WithResource(newResource()),

    )

// 下面让我们看一下它都有哪些配置

// 这里创建的是批量处理导出器,也就是我们常用的

WithBatcher(e SpanExporter, opts ...BatchSpanProcessorOption)

// 这里可以添加别的导出器,也就是说可以同时发送给jaeger与zipkin

WithSpanProcessor(sp SpanProcessor)

// 配置资源

WithResource(r *resource.Resource)

// Tracers id与span id生成器,默认为随机数

WithIDGenerator(g IDGenerator)

// 设置采样数

WithSampler(s Sampler)

// 设置属性,资源的数量

WithSpanLimits(sl SpanLimits)

WithRawSpanLimits(limits SpanLimits)

这里重点讲解一下SpanProcessor.
SpanProcessor是一个导出器策略,存储着如何发送span到链路服务器上,有两种方式批处理和立即发送。
我们上面说的WithCollectorEndpoint 与 WithAgentEndpoint 都是创建的BatchSpanProcessor 也就是批处理导出器策略.还存在一个SpanProcessor为simpleSpanProcessor,这个就是立刻发送,没有批处理操作.
我们添加其他导出器以及策略的方式:
如果使用BatchSpanProcessor 那么在创建TracerProvider时的传参使用trace.WithBatcher即可
如果想自定义,则使用WithSpanProcessor
比如使用simpleSpanProcessor,则设置为 WithSpanProcessor(jaeger.NewSimpleSpanProcessor(exporter SpanExporter))

没错，想要添加一个导出器就需要配置导出策略。所以导出器与导出策略时绑定的。

otel

otel是一个全局配置组件，我们可以将生成器设置为全局属性，方便调用。

1

otel.SetTracerProvider(tp)

注意

具体的span使用请访问
下文都是拷贝官网.

获取当前跨度

通过上面我们知道,对当前跨度的操作是使用span就可以了,但是在日常过程中我们不能传输两个值一个Context和span(通常只传输Context),所以可以使用Context逆向解析出当前的span.

1

2

ctx := context.TODO()

span := trace.SpanFromContext(ctx)

:::success
下面所有设置都会在每个span的log中展示出来,只是为了更能标识信息,没有实质性的用处.(比如设置even,并不是运行这个事件,只是输出一个key为even value 为msg的信息)
:::

设置span状态

1

span.SetStatus(codes.Error, "operationThatCouldFail failed")

设置span属性

1

span.SetAttributes(attribute.Bool("isTrue", true), attribute.String("stringAttr", "hi!"))

记录错误

1

span.RecordError(err)

设置活动

1

span.AddEvent("Acquiring lock")

tp.Shutdown

注意在使用完后已经要调用Shutdown，它的功能是关闭客户端与链路服务器之间的连接，也就是我们为两个服务建立连接后为了防止资源浪费所以会调用 con.close() 即使关闭.

1

2

3

4

5

defer func() {

        if err := tp.Shutdown(context.Background()); err != nil {

            fmt.Println(err)

        }

    }()

版权声明 : 本文内容来源于互联网或用户自行发布贡献，该文观点仅代表原作者本人。本站仅提供信息存储空间服务和不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权， 违法违规的内容， 请发送邮件至2530232025#qq.cn(#换@)举报，一经查实，本站将立刻删除。

您可能感兴趣的文章 :

原文链接 : https://blog.csdn.net/a1023934860/article/details/126969323
    Tag :
相关文章
  • 基于GORM实现CreateOrUpdate的方法
    CreateOrUpdate 是业务开发中很常见的场景，我们支持用户对某个业务实体进行创建/配置。希望实现的 repository 接口要达到以下两个要求： 如果
  • Golang中的内存逃逸的介绍
    什么是内存逃逸分析 内存逃逸分析是go的编译器在编译期间，根据变量的类型和作用域，确定变量是堆上还是栈上 简单说就是编译器在编译
  • Golang自旋锁的介绍
    自旋锁 获取锁的线程一直处于活跃状态，但是并没有执行任何有效的任务，使用这种锁会造成busy-waiting。 它是为实现保护共享资源而提出的

  • Go语言读写锁RWMutex的源码

    Go语言读写锁RWMutex的源码
    在前面两篇文章中初见 Go Mutex、Go Mutex 源码详解，我们学习了Go语言中的Mutex，它是一把互斥锁，每次只允许一个goroutine进入临界区，可以保
  • Go项目实现优雅关机与平滑重启功能
    什么是优雅关机？ 优雅关机就是服务端关机命令发出后不是立即关机，而是等待当前还在处理的请求全部处理完毕后再退出程序，是一种对
  • Go语言操作Excel利器之excelize类库的介绍
    在开发中一些需求需要通过程序操作excel文档，例如导出excel、导入excel、向excel文档中插入图片、表格和图表等信息，使用Excelize就可以方便

  • 利用Go语言快速实现一个极简任务调度系统

    利用Go语言快速实现一个极简任务调度系统
    任务调度（Task Scheduling）是很多软件系统中的重要组成部分，字面上的意思是按照一定要求分配运行一些通常时间较长的脚本或程序。在爬

  • GoLang中的iface 和 eface 的区别介绍

    GoLang中的iface 和 eface 的区别介绍
    GoLang之iface 和 eface 的区别是什么？ iface和eface都是 Go 中描述接口的底层结构体，区别在于iface描述的接口包含方法，而eface则是不包含任何方
  • Golang接口使用的教程
    go语言并没有面向对象的相关概念，go语言提到的接口和java、c++等语言提到的接口不同，它不会显示的说明实现了接口，没有继承、子类、
  • go colly 爬虫实现示例介绍
    贡献某CC，go源码爬虫一个，基于colly，效果是根据输入的浏览器cookie及excel必要行列号，从excel中读取公司名称，查询公司法人及电话号码。
推荐阅读
最新更新
友情链接
  • 本站所有内容来源于互联网或用户自行发布，本站仅提供信息存储空间服务，不拥有版权，不承担法律责任。如有侵犯您的权益，请您联系站长处理！
  • Copyright © 2017-2022 F11.CN All Rights Reserved. F11站长开发者网 版权所有 | 苏ICP备2022031554号-1 | 51LA统计