Snowpark Container Services：监控服务¶

使用 SYSTEM$GET_SERVICE_LOGS¶

您需要提供服务名称、实例 ID、容器名称，还可选择提供要检索的最新日志行数。如果只有一个服务实例正在运行，则服务实例 ID 为 0。例如，以下语句命令会从名为 echo 的容器的日志中检索末尾的 10 行，该容器属于名为 echo_service 的服务的实例 0：

SELECT SYSTEM$GET_SERVICE_LOGS('echo_service', '0', 'echo', 10);

输出示例：

+--------------------------------------------------------------------------+
| SYSTEM$GET_SERVICE_LOGS                                                  |
|--------------------------------------------------------------------------|
| 10.16.6.163 - - [11/Apr/2023 21:44:03] "GET /healthcheck HTTP/1.1" 200 - |
| 10.16.6.163 - - [11/Apr/2023 21:44:08] "GET /healthcheck HTTP/1.1" 200 - |
| 10.16.6.163 - - [11/Apr/2023 21:44:13] "GET /healthcheck HTTP/1.1" 200 - |
| 10.16.6.163 - - [11/Apr/2023 21:44:18] "GET /healthcheck HTTP/1.1" 200 - |
+--------------------------------------------------------------------------+
1 Row(s) produced. Time Elapsed: 0.878s

如果没有调用该函数所需的服务相关信息（如实例 ID 或容器名称），您可以先运行 SHOW SERVICE CONTAINERS IN SERVICE 命令获取每个实例中运行的服务实例和容器的相关信息。

SYSTEM$GET_SERVICE_LOGS 函数有以下限制：

• 它将标准输出和标准错误流合并。该函数没有说明输出来自哪个流。

• 它在单个服务实例中报告特定容器的捕获数据。

• 它只报告运行中容器的日志。该函数无法从先前重新启动的容器或者已停止或已删除的服务容器中获取日志。

• 该函数最多可返回 100 KB 数据。

使用事件表¶

Snowflake 可以获取从容器发送到标准输出的日志，并将标准错误流发送到为您的账户配置的事件表中。有关配置事件表的更多信息，请参阅 日志记录、跟踪和指标。

您可以通过使用服务规范文件中的 spec.logExporters 字段 来控制要收集哪些流（全部、仅标准错误或无）并将其存储在事件表中。

然后您可以查询事件表中的事件。要查找账户的活动事件表，请使用 SHOW PARAMETERS 命令检查 EVENT_TABLE 参数的值：

SHOW PARAMETERS LIKE 'event_table' IN ACCOUNT;

该参数指定账户的活动事件表。

接下来，查询该事件表。以下 SELECT 语句可检索过去一小时内记录的 Snowflake 服务和作业事件：

SELECT TIMESTAMP, RESOURCE_ATTRIBUTES, RECORD_ATTRIBUTES, VALUE
FROM <current-event-table-for-your-account>
WHERE timestamp > dateadd(hour, -1, current_timestamp())
AND RESOURCE_ATTRIBUTES:"snow.service.name" = <service-name>
AND RECORD_TYPE = 'LOG'
ORDER BY timestamp DESC
LIMIT 10;

Snowflake 建议您在事件表查询的 WHERE 子句中包含时间戳，如本例所示。这一点尤为重要，因为各种 Snowflake 组件可能会生成大量数据。通过应用筛选器，可以检索到较小的数据子集，从而提高查询性能。

事件表包括以下列，这些列提供了有关 Snowflake 从您的容器收集的日志的有用信息：

• TIMESTAMP： 显示 Snowflake 收集日志的时间。

• RESOURCE_ATTRIBUTES： 提供 JSON 对象，用于标识 Snowflake 服务和生成日志消息的服务中的容器。例如，它提供了服务运行时指定的服务名称、容器名称和计算池名称等详细信息。

  {
    "snow.account.name": "SPCSDOCS1",
    "snow.compute_pool.id": 20,
    "snow.compute_pool.name": "TUTORIAL_COMPUTE_POOL",
    "snow.compute_pool.node.id": "a17e8157",
    "snow.compute_pool.node.instance_family": "CPU_X64_XS",
    "snow.database.id": 26,
    "snow.database.name": "TUTORIAL_DB",
    "snow.schema.id": 212,
    "snow.schema.name": "DATA_SCHEMA",
    "snow.service.container.instance": "0",
    "snow.service.container.name": "echo",
    "snow.service.container.run.id": "b30566",
     "snow.service.id": 114,
    "snow.service.name": "ECHO_SERVICE2",
    "snow.service.type": "Service"
  }
  

  Copy

• RECORD_ATTRIBUTES： 对于 Snowflake 服务，它标识错误源（标准输出或标准错误）。

  { "log.iostream": "stdout" }
  

  Copy

• VALUE： 标准输出和标准错误被分成若干行，每一行都会在事件表中生成一条记录。

  "echo-service [2023-10-23 17:52:27,429] [DEBUG] Sending response: {'data': [[0, 'Joe said hello!']]}"
  

访问事件表服务指标¶

要将服务指标记录到为账户配置的事件表中，请在服务规范中包含以下部分：

platformMonitor:
  metricConfig:
    groups:
    - <group 1>
    - <group 2>
    - ...

其中，每个 group N 指的是您感兴趣的 预定义指标组 <label-spcs_available_platform_metrics>`（例如，``system`、network 或 storage）。有关更多信息，请参阅服务规范文档中的 spec.platformMonitor 字段 部分。

在服务运行时，Snowflake 会将这些指标记录到账户中的事件表中。您可以查询事件表来读取指标。以下查询检索了过去一小时内为服务 my_service 记录的服务指标：

SELECT timestamp, value
  FROM my_event_table_db.my_event_table_schema.my_event_table
  WHERE timestamp > DATEADD(hour, -1, CURRENT_TIMESTAMP())
    AND RESOURCE_ATTRIBUTES:"snow.service.name" = 'MY_SERVICE'
    AND RECORD_TYPE = 'METRIC'
    ORDER BY timestamp DESC
    LIMIT 10;

如果您不知道该账户的活动事件表的名称，请执行 SHOW PARAMETERS 命令来显示账户级别 EVENT_TABLE 参数的值：

SHOW PARAMETERS LIKE 'event_table' IN ACCOUNT;

有关事件表的更多信息，请参阅 使用事件表。

示例

按照以下步骤创建一个示例服务，将指标记录到为您的账户配置的事件表中。

1. 按照 教程 1 创建一个名为 echo_service 的服务，但有一处变化。在第 3 步中，创建服务时，使用以下 CREATE SERVICE 命令在修改后的服务规范中添加 platformMonitor 字段。

   CREATE SERVICE echo_service
     IN COMPUTE POOL tutorial_compute_pool
     FROM SPECIFICATION $$
       spec:
         containers:
         - name: echo
           image: /tutorial_db/data_schema/tutorial_repository/my_echo_service_image:latest
           env:
             SERVER_PORT: 8000
             CHARACTER_NAME: Bob
           readinessProbe:
             port: 8000
             path: /healthcheck
         endpoints:
         - name: echoendpoint
           port: 8000
           public: true
         platformMonitor:
           metricConfig:
             groups:
             - system
             - system_limits
         $$
       MIN_INSTANCES=1
       MAX_INSTANCES=1;
   

   Copy

2. 服务运行后，Snowflake 开始将指定的指标组中的指标记录到事件表中，供您之后查询。以下查询检索了 Echo 服务在过去一小时内报告的指标。

   SELECT timestamp, value
     FROM my_events
     WHERE timestamp > DATEADD(hour, -1, CURRENT_TIMESTAMP())
       AND RESOURCE_ATTRIBUTES:"snow.service.name" = 'ECHO_SERVICE'
       AND RECORD_TYPE = 'METRIC'
       AND RECORD:metric.name = 'container.cpu.usage'
       ORDER BY timestamp DESC
       LIMIT 100;
   

   Copy

访问计算池指标¶

计算池 指标可提供对计算池中的节点及其上运行的服务的洞察。每个节点可报告特定于节点的指标（例如容器的可用内存量），以及服务指标（例如各个容器的内存使用情况）。计算池指标从节点的角度提供信息。

每个节点都有一个指标发布器，用于监听 TCP 端口 9001。其他服务可以使用指向节点上端口 9001 的路径 /metrics 发出 HTTP GET 请求。要发现节点的 IP 地址，请从 DNS 中检索 discover.monitor.compute_pool_name.cp.spcs.internal 主机名的 SRV 记录（或 A 记录）。然后，在您的账户中创建另一项服务，用于主动轮询每个节点以检索指标。

响应中的正文使用 ` Prometheus 格式 <https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format (https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)>`_ 提供指标，如以下示例指标所示：

# HELP node_memory_capacity Defines SPCS compute pool resource capacity on the node
# TYPE node_memory_capacity gauge
node_memory_capacity{snow_compute_pool_name="MY_POOL",snow_compute_pool_node_instance_family="CPU_X64_S",snow_compute_pool_node_id="10.244.3.8"} 1
node_cpu_capacity{snow_compute_pool_name="MY_POOL",snow_compute_pool_node_instance_family="CPU_X64_S",snow_compute_pool_node_id="10.244.3.8"} 7.21397383168e+09

请注意以下事项：

• 响应主体以 # HELP 和 # TYPE 开头，提供简短描述和指标类型。在本示例中，node_memory_capacity 指标类型为 gauge。

• 然后是指标的名称、描述特定资源（数据点）的标签列表及其值。在本示例中，指标（名为 node_memory_capacity）提供了内存信息，表明节点有 7.2 GB 可用内存。该指标还包括标签形式的元数据，如下所示：

  snow_compute_pool_name="MY_POOL",
  snow_compute_pool_node_instance_family="CPU_X64_S",snow_compute_pool_node_id="10.244.3.8"
  

您可以选择任何方式来处理这些指标；例如，您可以将指标存储在数据库中，然后使用 UI（例如 Grafana 仪表板）来显示信息。

有关可用计算池指标的列表，请参阅 可用平台指标。

示例

有关配置 Prometheus 以轮询计算池来获取指标的示例，请参阅 计算池指标教程 (https://github.com/Snowflake-Labs/spcs-templates/tree/main/user-metrics)。

可用平台指标¶

以下是可用平台指标组以及每个组内的指标的列表。请注意，当前仅从块存储卷收集 storage 指标。

发布 OTLP 应用程序指标和跟踪¶

Snowflake 会运行一个 OTel 收集器，您的服务容器可使用该收集器发布 OTLP 应用程序指标和跟踪。也就是说，服务容器可以将指标推送到 OTel 收集器端点，然后 Snowflake 会将这些指标连同源服务详细信息写入为您的 Snowflake 账户配置的事件表中。

它的工作原理如下：

• Snowflake 会在您的服务容器中自动填充以下环境变量，这些变量提供了 OTel 收集器端点，容器可以在这些端点上发布应用程序指标和跟踪。

  • OTEL_EXPORTER_OTLP_METRICS_ENDPOINT

  • OTEL_EXPORTER_OTLP_TRACES_ENDPOINT

• 标准 OTLP 客户端 (https://opentelemetry.io/docs/languages/) 会查找这些环境变量，以自动发现 OTel 收集器。这样，您的服务容器就可以使用此客户端发布指标和跟踪。

from opentelemetry.sdk.trace import TracerProvider
from snowflake.telemetry.trace import SnowflakeTraceIdGenerator


trace_id_generator = SnowflakeTraceIdGenerator()
tracer_provider = TracerProvider(
    resource=Resource.create({"service.name": SERVICE_NAME}),
    id_generator=trace_id_generator
)

import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
import com.snowflake.telemetry.trace.SnowflakeTraceIdGenerator;

static OpenTelemetry initOpenTelemetry() {
  return AutoConfiguredOpenTelemetrySdk.builder()
      .addPropertiesSupplier(
          () ->
              Map.of(...config options...)
      .addTracerProviderCustomizer(
          (tracerProviderBuilder, configProperties) -> {
            tracerProviderBuilder.setIdGenerator(SnowflakeTraceIdGenerator.INSTANCE);
            return tracerProviderBuilder;
          })
      .build()
      .getOpenTelemetrySdk();

发布 Prometheus 应用程序指标¶

Snowflake 支持 Prometheus 指标，其中，您的应用程序可能会暴露 Prometheus 指标，由 Snowflake 提供的收集器进行轮询，而不是推送 OTLP 指标。为了让 Snowflake 从您的服务收集应用程序指标并将其发布到事件表，请执行以下步骤：

• 让您的服务监听一个端口，以暴露 Prometheus 指标。

• 在您的服务中包含一个 Snowflake 提供的容器（也称为“sidecar”容器），并进行必要的配置，以从您的服务容器中拉取指标。

Prometheus sidecar 容器按计划频率从服务容器中拉取应用程序指标，将 Prometheus 格式转换为 OTLP 格式，并将指标推送到 OTel 收集器。然后，OTel 收集器会将这些指标发布到为您的 Snowflake 账户配置的事件表中。

您将 Prometheus sidecar 容器作为另一个容器添加到服务规范中，并包括一个参数来指定您的容器暴露的 HTTP 端点，格式如下：

localhost:{PORT}/{METRICS_PATH}, {SCRAPE_FREQUENCY}

它指定了端口号、路径以及 sidecar 容器应当拉取指标的频率。

下面是一个示例服务规范片段，展示了 sidecar 容器每分钟从端口 8000 拉取服务容器的指标，并从路径“/metrics”拉取指标：

spec:
  containers:
  - name: <name>
    image: <image-name>
    .....
  - name: prometheus
    image: /snowflake/images/snowflake_images/monitoring-prometheus-sidecar:0.0.1
    args:
      - "-e"
      - "localhost:8000/metrics,1m"

在规范中：

• image 是 Snowflake 提供的 sidecar 容器映像。

• args 提供必要配置以使 Prometheus 容器抓取指标：

  • 从容器提供的端口 8000。在此 Prometheus 容器配置中，端口是必填项。

  • 使用路径“/metrics”。这是可选项。如果未指定，默认路径为“/metrics”。

  • 每一分钟。这是可选项。如果未指定，则默认值为“1m”。

  如果使用默认值，抓取指标的配置等效于以下内容：

  spec:
      ...
      args:
        - "-e"
        - "localhost:8000"
  

  Copy

访问事件表中的应用程序指标和跟踪¶

您可以查询事件表来检索应用程序指标。以下查询可用于检索过去一小时内收集的应用程序指标。

SELECT timestamp, record:metric.name, value
  FROM <current_event_table_for_your_account>
  WHERE timestamp > dateadd(hour, -1, CURRENT_TIMESTAMP())
    AND resource_attributes:"snow.service.name" = <service_name>
    AND scope:"name" != 'snow.spcs.platform'
    AND record_type = 'METRIC'
  ORDER BY timestamp DESC
  LIMIT 10;

有关事件表的更多信息，请参阅 事件表概述。这些指标可以在 Snowflake 仪表板 中直观显示。

您还可以查询事件表，以查看应用程序跟踪。例如，要检索过去一小时内的应用程序跟踪，可替换前述查询中的 record_type 条件，如下所示：

AND record_type = 'SPAN' OR record_type = 'SPAN_EVENT'

这些跟踪可以在 `Snowflake trail<https://www.snowflake.com/en/data-cloud/snowflake-trail/>`__ 查看器中直观显示。

指标和跟踪包含用户定义和 Snowflake 定义的属性，这些属性被划分为资源和记录属性。请注意，snow. 前缀是为 Snowflake 生成的属性保留的，Snowflake 会忽略使用此前缀的自定义属性。要查看 Snowflake 定义属性的列表，请参阅 可用平台指标。

提供了 示例代码 (https://github.com/Snowflake-Labs/spcs-templates/tree/main/application-observability)，分别使用 Python 和 Java 展示了如何使用 OTLP SDK 为应用程序添加自定义指标和跟踪。示例展示了如何配置 Snowflake Trace ID 生成，以便与用于跟踪的 Snowflake 跟踪查看器兼容。