将路由器日志记录到stdout

配置stdcout日志

您可以配置GraphOS 路由器或Apollo 路由器核心的日志输出将被定向到标准输出，且其输出格式可以设置为文本或 JSON。

有关一般日志配置，请参阅路由器日志配置。

标准输出配置

`启用`

默认情况下，标准输出日志输出是禁用的。

要启用标准输出日志，将enabled选项设置为true：

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true

`格式`

您可以配置日志输出格式。默认格式取决于路由器的运行方式：

在交互式shell中，text是默认的。
在非交互式shell中，json是默认的。

您可以在router.yaml中使用telemetry.exporters.logging.stdout.format显式设置格式：

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: text

`tty_format`

当您在交互式shell中运行时，您可以配置日志格式。这在开发期间很有用。

如果同时配置了format和tty_format，则输出取决于router运行的环境：

在交互式shell中，tty_format将具有优先权。
在非交互式shell中，format将具有优先权。

您可以在router.yaml中使用telemetry.exporters.logging.stdout.tty_format显式设置格式：

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: json
7
         tty_format: text

`rate_limit`

日志消息的生产速率可能太高，尤其是在请求处理错误时。为了防止router的日志被冗余消息填满，您可以使用rate_limit选项来设置日志速率限制。

您可以针对每个日志位置设置日志速率限制，不同日志信息可以独立速率限制，具有相同信息但不同属性集度的日志行在相同速率下进行限制。此速率限制仅适用于向 stdout 日志记录，不影响发送到 OTLP 等具有自己的采样配置的跟踪导出器的事件。

要启用速率限制，设置 rate_limit 选项：

router.yaml

1
telemetry:
2
  exporters:
3
    logging:
4
      stdout:
5
        format: json
6
        rate_limit: 
7
          capacity: 1  # number of allowed messages during the rate limiting interval
8
          interval: 3s

有关每个输出格式特有的配置选项，请参阅 text 和 json 格式参考。

配置参考

选项	值	默认	描述
`启用`	`true`\|`false`	`false`	启用或禁用 stdout 日志记录。
`格式`		`text`\|`json`	有关详情，请参阅格式文档。
`tty_format`		`text`\|`json`	有关详情，请参阅格式文档。

日志输出格式

您可以为日志配置不同的输出格式

text
json

每种格式都有其特定的配置设置。

`text`

text 格式可读性强，非常适合开发调试。它是默认的日志输出格式。

要使用 text 格式，在 router.yaml 中启用 telemetry.exporters.logging.stdout并将格式设置为 text：

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: text # The default text format will be used

text 格式还可以用作 YAML 中的键，telemetry.exporters.logging.stdout.format.text，以指定高级配置选项：

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format:
7
           text: 
8
              ansi_escape_codes: true
9
              display_filename: true
10
              display_level: true
11
              display_line_number: true
12
              display_target: true
13
              display_thread_id: true
14
              display_thread_name: true
15
              display_timestamp: true
16
              display_resource: true
17
              display_span_list: true
18
              display_current_span: true
19
              display_service_name: true
20
              display_service_namespace: true
21
              display_trace_id: true
22
              display_span_id: true

示例 text 输出：

1
2023-10-30T15:49:34.174435Z  INFO trace_id: bbafc3f048b6137375dd78c10df18f50 span_id: 40ede28c5df1b5cc main ThreadId(01) span_name{span_attr_1="span_attr_1" span_attr_2="span_attr_2"}: event_target: event_file.rs:32: event_attr_1="event_attr_1" event_attr_2="event_attr_2"

文本配置参考

选项	值	默认	描述
`ansi_escape_codes`	`true`\|`false`	`true`	使用ANSI终端转义码。
`display_filename`	`true`\|`false`	`false`	日志事件发生时的文件名。
`display_level`	`true`\|`false`	`true`	日志事件的等级，如INFO、WARN、ERROR、TRACE。
`display_line_number`	`true`\|`false`	`false`	事件发生的行号。
`display_target`	`true`\|`false`	`false`	事件发生的模块名。
`display_thread_id`	`true`\|`false`	`false`	事件发生的线程ID。
`display_thread_name`	`true`\|`false`	`false`	事件发生的线程名。
`display_timestamp`	`true`\|`false`	`true`	事件发生的时间戳。
`display_service_name`	`true`\|`false`	`false`	在metrics common中配置的服务名。
`display_service_namespace`	`true`\|`false`	`false`	在metrics common中配置的服务命名空间。
`display_trace_id`	`true`\|`false`	`false`	事件发生的span中的跟踪ID。
`display_span_id`	`true`\|`false`	`false`	事件发生的span中的span ID。
`display_span_list`	`true`\|`false`	`true`	一个记录了事件发生及其所有属性的所有span到根的列表。
`display_current_span`	`true`\|`false`	`true`	事件发生的span及其所有属性。

`json`

该json格式是一种机器可读格式，非常适合作为应用程序性能监控器（APM）的输入。

路由器支持由tracing-subscriber提供的结构化JSON输出。

要使用json格式，在router.yaml中启用telemetry.exporters.logging.stdout并将格式设置为json:

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: json

每个日志条目将是一个单个的、格式良好的JSON文档，非常适合在您的首选APM工具中处理。

示例默认json输出：

stdout

1
{
2
  "timestamp": "2023-10-30T14:09:34.771388Z",
3
  "level": "INFO",
4
  "trace_id": "54ac7e5f0e8ab90ae67b822e95ffcbb8",
5
  "span_id": "d52e3478c718b8a9",
6
  "fields": {
7
    "event_attr_1": "event_attr_1",
8
    "event_attr_2": "event_attr_2"
9
  },
10
  "target": "event_target"
11
}

您可以通过在router.yaml中指定telemetry.exporters.logging.stdout.format.json作为键来配置包含在JSON输出中的属性。

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: 
7
           json:
8
             display_filename: false
9
             display_level: true
10
             display_line_number: false
11
             display_target: false
12
             display_thread_id: false
13
             display_thread_name: false
14
             display_timestamp: true
15
             display_current_span: true
16
             display_span_list: true
17
             display_resource: true
18
             display_trace_id: true
19
             display_span_id: true

示例json输出：

1
{
2
  "timestamp": "2023-10-30T15:47:52.570482Z",
3
  "level": "INFO",
4
  "trace_id": "54ac7e5f0e8ab90ae67b822e95ffcbb8",
5
  "span_id": "d52e3478c718b8a9",
6
  "fields": {
7
    "event_attr_1": "event_attr_1",
8
    "event_attr_2": "event_attr_2"
9
  },
10
  "target": "event_target",
11
  "filename": "event_file.rs",
12
  "line_number": 32,
13
  "span": {
14
    "span_attr_1": "span_attr_1",
15
    "span_attr_2": "span_attr_2",
16
    "name": "span_name"
17
  },
18
  "spans": [
19
    {
20
      "span_attr_1": "span_attr_1",
21
      "span_attr_2": "span_attr_2",
22
      "name": "span_name"
23
    }
24
  ],
25
  "threadName": "main",
26
  "threadId": "ThreadId(1)"
27
}

`display_current_span`

事件还可能输出关于它们所发生的span的信息，这对于记录特定请求的span附加属性非常有用。

要记录span信息，请将telemetry.exporters.logging.stdout.format.json.display_current_span选项设置为true:

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: 
7
           json:
8
             display_current_span: true

包含span信息的示例输出

1
{
2
  "timestamp": "2023-10-30T14:09:34.771388Z",
3
  "level": "INFO",
4
  "fields": {
5
    "event_attr_1": "event_attr_1",
6
    "event_attr_2": "event_attr_2"
7
  },
8
  "target": "event_target",
9
  "span": {
10
    "span_attr_1": "span_attr_1",
11
    "span_attr_2": "span_attr_2",
12
    "name": "span_name"
13
  }
14
}

`display_span_list`

该telemetry.exporters.logging.stdout.format.json.display_span_list选项与display_current_span类似，但不同之处在于，display_span_list输出所有事件发生的span的信息，而不仅仅是当前span的信息。

例如，如果您在请求头中有一个自定义的trace_id，只要在router 段落上配置了该属性，它就会出现在与请求相关的所有日志事件上。

router.yaml

1
telemetry:
2
  exporters:
3
     logging:
4
       stdout:
5
         enabled: true
6
         format: 
7
           json:
8
             display_span_list: true

带有跨度列表的示例输出

1
{
2
  "timestamp": "2023-10-30T14:09:34.771388Z",
3
  "level": "INFO",
4
  "fields": {
5
    "event_attr_1": "event_attr_1",
6
    "event_attr_2": "event_attr_2"
7
  },
8
  "target": "event_target",
9
  "spans": [
10
    {
11
      "span_attr_1": "span_attr_1",
12
      "span_attr_2": "span_attr_2",
13
      "name": "span_name"
14
    }
15
  ]
16
}

`显示资源`

配置选项 telemetry.logging.stdout.format.json.display_resource controls whether the resources specified in router.yaml are displayed in log messages. By default, display_resource is true).

例如，给定一个包含 display_resource: true 的 router.yaml 和已配置的 resource，日志消息将显示资源：

router.yaml

1
telemetry:
2
  exporters:
3
    logging:
4
      stdout:
5
        format: 
6
          json:
7
            display_resource: true
8
      common:
9
        service_name: bryn-router
10
        resource:
11
          test.resource: test

"resource":{"test.resource":"test","service.name":"bryn-router"}

`json` 配置参考

选项	值	默认	事件字段	描述
`display_current_span`	`true`\|`false`	`false`	`跨度`	事件发生的span及其所有属性。
`display_filename`	`true`\|`false`	`false`	`文件名`	日志事件发生时的文件名。
`display_level`	`true`\|`false`	`true`	`级别`	日志事件的等级，如INFO、WARN、ERROR、TRACE。
`display_line_number`	`true`\|`false`	`false`	`行号`	事件发生的行号。
`display_target`	`true`\|`false`	`true`	`目标`	事件发生的模块名。
`display_thread_id`	`true`\|`false`	`false`	`线程ID`	事件发生的线程ID。
`display_thread_name`	`true`\|`false`	`false`	`线程名`	事件发生的线程名。
`display_timestamp`	`true`\|`false`	`true`	`时间戳`	事件发生的时间戳。
`display_span_list`	`true`\|`false`	`true`	`跨度`	一个记录了事件发生及其所有属性的所有span到根的列表。
`显示资源`	`true`\|`false`	`true`	`资源`	在跟踪公共配置的资源
`display_trace_id`	`true`\|`false`	`true`	`跟踪ID`	事件发生的span中的跟踪ID。
`display_span_id`	`true`\|`false`	`true`	`跨度ID`	事件被提升的跨度的跨度ID。