17.3. 使用 PTP 硬件快速事件通知框架

17.3.1. 关于 PTP 和时钟同步错误事件

丢失 PTP 同步是 RAN 网络的一个关键错误。如果在节点上丢失同步，则可能会关闭无线广播，并且网络 Over the Air (OTA) 流量可能会转移到无线网络中的另一个节点。快速事件通知允许集群节点与 DU 中运行的 vRAN 应用程序通信 PTP 时钟同步状态，从而缓解工作负载错误。

事件通知可用于在同一 DU 节点上运行的 vRAN 应用。发布/订阅 REST API 将事件通知传递到消息传递总线。发布-订阅消息传递或发布-订阅消息传递是服务通信架构的异步服务，通过服务通信架构，所有订阅者会立即收到发布到某一主题的消息。

PTP Operator 为每个支持 PTP 的网络接口生成快速事件通知。您可以通过 HTTP 或 Advanced Message Queuing Protocol (AMQP) 消息总线使用 cloud-event-proxy sidecar 容器来访问事件。

注意

PTP 快速事件通知可用于配置为使用 PTP 普通时钟、PTP grandmaster 时钟或 PTP 边界时钟。

注意

HTTP 传输是 PTP 和裸机事件的默认传输。在可能的情况下，使用 HTTP 传输而不是 AMQP 用于 PTP 和裸机事件。AMQ Interconnect 于 2024 年 6 月 30 日结束生命周期（EOL）。AMQ Interconnect 的延长生命周期支持 (ELS) 于 2029 年 11 月 29 日结束。如需更多信息，请参阅 Red Hat AMQ Interconnect 支持状态。

17.3.2. 关于 PTP 快速事件通知框架

使用 Precision Time Protocol (PTP) 快速事件通知框架，将集群应用程序订阅到裸机集群节点的 PTP 事件。

注意

快速事件通知框架使用 REST API 进行通信。REST API 基于 O-RAN O-Cloud Notification API Specification for Event Consumers 3.0，它包括在 O-RAN ALLIANCE Specifications 中。

框架由发布者、订阅者和 AMQ 或 HTTP 消息传递协议组成，用于处理发布者和订阅者应用程序之间的通信。应用程序以 sidecar 模式运行 cloud-event-proxy 容器，以订阅 PTP 事件。cloud-event-proxy sidecar 容器可以访问与主应用程序容器相同的资源，而无需使用主应用程序的任何资源，且没有大量延迟。

注意

HTTP 传输是 PTP 和裸机事件的默认传输。在可能的情况下，使用 HTTP 传输而不是 AMQP 用于 PTP 和裸机事件。AMQ Interconnect 于 2024 年 6 月 30 日结束生命周期（EOL）。AMQ Interconnect 的延长生命周期支持 (ELS) 于 2029 年 11 月 29 日结束。如需更多信息，请参阅 Red Hat AMQ Interconnect 支持状态。

图 17.4. PTP 快速事件概述

事件在集群主机上生成: PTP Operator 管理的 pod 中的 linuxptp-daemon 作为 Kubernetes DaemonSet 运行，并管理各种 linuxptp 进程 (ptp4l、phc2sys，以及可选的用于 grandmaster 时钟 ts2phc)。linuxptp-daemon 将事件传递给 UNIX 域套接字。
事件传递给 cloud-event-proxy sidecar: PTP 插件从 UNIX 域套接字读取事件，并将其传递给 PTP Operator 管理的 pod 中的 cloud-event-proxy sidecar。cloud-event-proxy 将 Kubernetes 基础架构的事件提供给具有低延迟的 Cloud-Native Network Function (CNF)。
事件是持久的: PTP Operator 管理的 pod 中的 cloud-event-proxy sidecar 处理事件，并使用 REST API 发布云原生事件。
消息已传输: 消息传输程序通过 HTTP 或 AMQP 1.0 QPID 将事件传送到应用程序 pod 中的 cloud-event-proxy sidecar。
来自 REST API 的事件: Application pod 中的 cloud-event-proxy sidecar 处理事件并使用 REST API 使其可用。
消费者应用程序请求订阅并接收订阅的事件: 消费者应用程序向应用程序 pod 中的 cloud-event-proxy sidecar 发送 API 请求，以创建 PTP 事件订阅。cloud-event-proxy sidecar 为订阅中指定的资源创建一个 AMQ 或 HTTP 消息传递监听程序协议。

应用程序 pod 中的 cloud-event-proxy sidecar 接收来自 PTP Operator 管理的 pod 的事件，取消封装云事件对象以检索数据，并将事件发布到消费者应用程序。消费者应用程序侦听资源限定符中指定的地址，并接收和处理 PTP 事件。

17.3.3. 配置 PTP 快速事件通知发布程序

要为集群中的网络接口启动使用 PTP fast 事件通知，您必须在 PTP Operator PtpOperatorConfig 自定义资源 (CR) 中启用快速事件发布程序，并在您创建的 PtpConfig CR 中配置 ptpClockThreshold 值。

先决条件

已安装 OpenShift Container Platform CLI (oc)。
您已以具有 cluster-admin 权限的用户身份登录。
已安装 PTP Operator。

流程

修改默认 PTP Operator 配置以启用 PTP 快速事件。
1. 在 ptp-operatorconfig.yaml 文件中保存以下 YAML：
```
apiVersion: ptp.openshift.io/v1
kind: PtpOperatorConfig
metadata:
  name: default
  namespace: openshift-ptp
spec:
  daemonNodeSelector:
    node-role.kubernetes.io/worker: ""
  ptpEventConfig:
    enableEventPublisher: true 1
```
  1
  将 enableEventPublisher 设置为 true 以启用 PTP 快速事件通知。
注意
在 OpenShift Container Platform 4.13 或更高版本中，当将 HTTP 传输用于 PTP 事件时，您不需要在 PtpOperatorConfig 资源中设置 spec.ptpEventConfig.transportHost 字段。仅在 PTP 事件中使用 AMQP 传输时设置 transportHost。
1. 更新 PtpOperatorConfig CR：
```
$ oc apply -f ptp-operatorconfig.yaml
```
为 PTP 启用接口创建 PtpConfig 自定义资源(CR)，并设置 ptpClockThreshold 和 ptp4lOpts 所需的值。以下 YAML 演示了您必须在 PtpConfig CR 中设置的必要值：
```
spec:
  profile:
  - name: "profile1"
    interface: "enp5s0f0"
    ptp4lOpts: "-2 -s --summary_interval -4" 1
    phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" 2
    ptp4lConf: "" 3
    ptpClockThreshold: 4
      holdOverTimeout: 5
      maxOffsetThreshold: 100
      minOffsetThreshold: -100
```
1
附加 --summary_interval -4 以使用 PTP 快速事件。
2
所需的 phc2sysOpts 值。-m 将消息输出到 stdout。linuxptp-daemon DaemonSet 解析日志并生成 Prometheus 指标。
3
指定一个字符串，其中包含要替换默认的 /etc/ptp4l.conf 文件的配置。要使用默认配置，请将字段留空。
4
可选。如果 ptpClockThreshold 小节不存在，则默认值用于 ptpClockThreshold 字段。小节显示默认的 ptpClockThreshold 值。ptpClockThreshold 值配置 PTP master 时钟在触发 PTP 事件前的时长。holdOverTimeout 是在 PTP master clock 断开连接时，PTP 时钟事件状态更改为 FREERUN 前的时间值（以秒为单位）。maxOffsetThreshold 和 minOffsetThreshold 设置以纳秒为单位，它们与 CLOCK_REALTIME (phc2sys) 或 master 偏移 (ptp4l) 的值进行比较。当 ptp4l 或 phc2sys 偏移值超出这个范围时，PTP 时钟状态被设置为 FREERUN。当偏移值在这个范围内时，PTP 时钟状态被设置为 LOCKED。

其他资源

有关将 linuxptp 服务配置为具有 PTP 快速事件的普通时钟的完整示例 CR，请参阅将 linuxptp 服务配置为普通时钟。

17.3.4. 迁移消费者应用程序，以使用 PTP 或裸机事件的 HTTP 传输

如果您之前部署了 PTP 或裸机事件消费者应用程序，您需要更新应用程序以使用 HTTP 消息传输。

先决条件

已安装 OpenShift CLI(oc)。
您已以具有 cluster-admin 权限的用户身份登录。
您已将 PTP Operator 或 Bare Metal Event Relay 更新至使用 HTTP 传输的版本 4.13+。

流程

更新您的事件消费者应用以使用 HTTP 传输。为云事件 sidecar 部署设置 http-event-publishers 变量。
例如，在配置了 PTP 事件的集群中，以下 YAML 片断演示了一个云事件 sidecar 部署：
```
containers:
  - name: cloud-event-sidecar
    image: cloud-event-sidecar
    args:
      - "--metrics-addr=127.0.0.1:9091"
      - "--store-path=/store"
      - "--transport-host=consumer-events-subscription-service.cloud-events.svc.cluster.local:9043"
      - "--http-event-publishers=ptp-event-publisher-service-NODE_NAME.openshift-ptp.svc.cluster.local:9043" 1
      - "--api-port=8089"
```
1
PTP Operator 会自动将 NODE_NAME 解析为正在生成 PTP 事件的主机。例如，compute-1.example.com。
在配置了裸机事件的集群中，在云事件 sidecar 部署 CR 中将 http-event-publishers 字段设置为 hw-event-publisher-service.openshift-bare-metal-events.svc.cluster.local:9043。

将 consumer-events-subscription-service 服务与事件消费者应用程序一起部署。例如：

apiVersion: v1
kind: Service
metadata:
  annotations:
    prometheus.io/scrape: "true"
    service.alpha.openshift.io/serving-cert-secret-name: sidecar-consumer-secret
  name: consumer-events-subscription-service
  namespace: cloud-events
  labels:
    app: consumer-service
spec:
  ports:
    - name: sub-port
      port: 9043
  selector:
    app: consumer
  clusterIP: None
  sessionAffinity: None
  type: ClusterIP

17.3.5. 安装 AMQ 消息传递总线

要在节点上的发布程序与订阅者之间传递 PTP 快速事件通知，您必须安装和配置 AMQ 消息传递总线，以便在节点上本地运行。要使用 AMQ 消息传递，您必须安装 AMQ Interconnect Operator。

注意

HTTP 传输是 PTP 和裸机事件的默认传输。在可能的情况下，使用 HTTP 传输而不是 AMQP 用于 PTP 和裸机事件。AMQ Interconnect 于 2024 年 6 月 30 日结束生命周期（EOL）。AMQ Interconnect 的延长生命周期支持 (ELS) 于 2029 年 11 月 29 日结束。如需更多信息，请参阅 Red Hat AMQ Interconnect 支持状态。

先决条件

安装 OpenShift Container Platform CLI（oc）。
以具有 cluster-admin 特权的用户身份登录。

流程

将 AMQ Interconnect Operator 安装到其自己的 amq-interconnect 命名空间。请参阅添加 Red Hat Integration - AMQ Interconnect Operator。

验证

检查 AMQ Interconnect Operator 是否可用，且所需的 pod 是否正在运行：

$ oc get pods -n amq-interconnect

输出示例

NAME                                    READY   STATUS    RESTARTS   AGE
amq-interconnect-645db76c76-k8ghs       1/1     Running   0          23h
interconnect-operator-5cb5fc7cc-4v7qm   1/1     Running   0          23h

检查所需的 linuxptp-daemon PTP 事件制作者 pod 是否在 openshift-ptp 命名空间中运行。

$ oc get pods -n openshift-ptp

输出示例

NAME                     READY   STATUS    RESTARTS       AGE
linuxptp-daemon-2t78p    3/3     Running   0              12h
linuxptp-daemon-k8n88    3/3     Running   0              12h

17.3.6. 使用 REST API 将 DU 应用程序订阅到 PTP 事件

使用资源地址 /cluster/node/<node_name>/ptp 将应用程序订阅到 PTP 事件，其中 <node_name> 是运行 DU 应用程序的集群节点。

在单独的 DU 应用程序 pod 中部署 cloud-event-consumer DU 应用程序容器和 cloud-event-proxy sidecar 容器。cloud-event-consumer DU 应用程序订阅应用程序 Pod 中的 cloud-event-proxy 容器。

使用以下 API 端点，将 cloud-event-consumer DU 应用程序订阅到 PTP 事件，这些事件由 cloud-event-proxy 容器发布，位于 DU 应用程序 pod 中的 http://localhost:8089/api/ocloudNotifications/v1/：

/api/ocloudNotifications/v1/subscriptions
- POST ：创建新订阅
- GET ：删除订阅列表
- DELETE ：删除所有订阅
/api/ocloudNotifications/v1/subscriptions/{subscription_id}
- GET ：返回指定订阅 ID 的详情
- DELETE ：删除与指定订阅 ID 关联的订阅
/api/ocloudNotifications/v1/health
- GET：返回 ocloudNotifications API 的健康状况
api/ocloudNotifications/v1/publishers
- GET ：为集群节点返回数组 os-clock-sync-state、ptp-clock-class-change、lock-state 和 gnss-sync-status 消息
/api/ocloudnotifications/v1/{resource_address}/CurrentState
- GET ：返回以下事件类型的当前状态： os-clock-sync-state、ptp-clock-class-change、lock-state 或 gnss-state-change 事件

注意

9089 是在应用程序 Pod 中部署的 cloud-event-consumer 容器的默认端口。您可以根据需要为 DU 应用程序配置不同的端口。

17.3.6.1. PTP 事件 REST API 参考

使用 PTP 事件通知 REST API 将集群应用程序订阅到父节点上生成的 PTP 事件。

17.3.6.1.1. api/ocloudNotifications/v1/subscriptions

HTTP 方法

GET api/ocloudNotifications/v1/subscriptions

描述

返回订阅列表。如果订阅存在，则返回 200 OK 状态代码以及订阅列表。

API 响应示例

[
 {
  "id": "75b1ad8f-c807-4c23-acf5-56f4b7ee3826",
  "endpointUri": "http://localhost:9089/event",
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions/75b1ad8f-c807-4c23-acf5-56f4b7ee3826",
  "resource": "/cluster/node/compute-1.example.com/ptp"
 }
]

HTTP 方法

POST api/ocloudNotifications/v1/subscriptions

描述

创建新订阅。如果订阅成功创建，或者已存在，则返回 201 Created 状态代码。

表 17.11. 查询参数
参数	类型
subscription	data

有效负载示例

{
  "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions",
  "resource": "/cluster/node/compute-1.example.com/ptp"
}

HTTP 方法

DELETE api/ocloudNotifications/v1/subscriptions

描述

删除所有订阅。

API 响应示例

{
"status": "deleted all subscriptions"
}

17.3.6.1.2. api/ocloudNotifications/v1/subscriptions/{subscription_id}

HTTP 方法

GET api/ocloudNotifications/v1/subscriptions/{subscription_id}

描述

返回 ID 为 subscription_id 的订阅详情。

表 17.12. 全局路径参数
参数	类型
`subscription_id`	string

API 响应示例

{
  "id":"48210fb3-45be-4ce0-aa9b-41a0e58730ab",
  "endpointUri": "http://localhost:9089/event",
  "uriLocation":"http://localhost:8089/api/ocloudNotifications/v1/subscriptions/48210fb3-45be-4ce0-aa9b-41a0e58730ab",
  "resource":"/cluster/node/compute-1.example.com/ptp"
}

HTTP 方法

DELETE api/ocloudNotifications/v1/subscriptions/{subscription_id}

描述

使用 ID subscription_id 删除订阅。

表 17.13. 全局路径参数
参数	类型
`subscription_id`	string

API 响应示例

{
"status": "OK"
}

17.3.6.1.3. api/ocloudNotifications/v1/health

HTTP 方法

GET api/ocloudNotifications/v1/health/

描述

返回 ocloudNotifications REST API 的健康状况。

API 响应示例

OK

17.3.6.1.4. api/ocloudNotifications/v1/publishers

HTTP 方法

GET api/ocloudNotifications/v1/publishers

描述

返回集群节点的 os-clock-sync-state、ptp-clock-class-change、lock-state 和 gnss-sync-status 详情的数组。当相关的设备状态改变时，系统会生成通知。

os-clock-sync-state 通知描述了主机操作系统时钟同步状态。可以是 LOCKED 或 FREERUN 状态。
ptp-clock-class-change 通知描述了 PTP 时钟类的当前状态。
lock-state 通知描述了 PTP 设备锁定状态的当前状态。可以处于 LOCKED、HOLDOVER 或 FREERUN 状态。
gNSS-sync-status 通知描述了与外部 GNSS 时钟信号相关的 GPS 同步状态。可以是 LOCKED 或 FREERUN 状态。

您可以组合使用设备同步状态订阅，以提供有关系统总体同步健康状况的详细视图。

API 响应示例

[
  {
    "id": "0fa415ae-a3cf-4299-876a-589438bacf75",
    "endpointUri": "http://localhost:9085/api/ocloudNotifications/v1/dummy",
    "uriLocation": "http://localhost:9085/api/ocloudNotifications/v1/publishers/0fa415ae-a3cf-4299-876a-589438bacf75",
    "resource": "/cluster/node/compute-1.example.com/sync/sync-status/os-clock-sync-state"
  },
  {
    "id": "28cd82df-8436-4f50-bbd9-7a9742828a71",
    "endpointUri": "http://localhost:9085/api/ocloudNotifications/v1/dummy",
    "uriLocation": "http://localhost:9085/api/ocloudNotifications/v1/publishers/28cd82df-8436-4f50-bbd9-7a9742828a71",
    "resource": "/cluster/node/compute-1.example.com/sync/ptp-status/ptp-clock-class-change"
  },
  {
    "id": "44aa480d-7347-48b0-a5b0-e0af01fa9677",
    "endpointUri": "http://localhost:9085/api/ocloudNotifications/v1/dummy",
    "uriLocation": "http://localhost:9085/api/ocloudNotifications/v1/publishers/44aa480d-7347-48b0-a5b0-e0af01fa9677",
    "resource": "/cluster/node/compute-1.example.com/sync/ptp-status/lock-state"
  },
  {
    "id": "778da345d-4567-67b0-a43f0-rty885a456",
    "endpointUri": "http://localhost:9085/api/ocloudNotifications/v1/dummy",
    "uriLocation": "http://localhost:9085/api/ocloudNotifications/v1/publishers/778da345d-4567-67b0-a43f0-rty885a456",
    "resource": "/cluster/node/compute-1.example.com/sync/gnss-status/gnss-sync-status"
  }
]

您可以在 cloud-event-proxy 容器的日志中找到 os-clock-sync-state、ptp-clock-class-change、lock-state 和 gnss-sync-status 事件。例如：

$ oc logs -f linuxptp-daemon-cvgr6 -n openshift-ptp -c cloud-event-proxy

os-clock-sync-state 事件示例

{
   "id":"c8a784d1-5f4a-4c16-9a81-a3b4313affe5",
   "type":"event.sync.sync-status.os-clock-sync-state-change",
   "source":"/cluster/compute-1.example.com/ptp/CLOCK_REALTIME",
   "dataContentType":"application/json",
   "time":"2022-05-06T15:31:23.906277159Z",
   "data":{
      "version":"v1",
      "values":[
         {
            "resource":"/sync/sync-status/os-clock-sync-state",
            "dataType":"notification",
            "valueType":"enumeration",
            "value":"LOCKED"
         },
         {
            "resource":"/sync/sync-status/os-clock-sync-state",
            "dataType":"metric",
            "valueType":"decimal64.3",
            "value":"-53"
         }
      ]
   }
}

ptp-clock-class-change 事件示例

{
   "id":"69eddb52-1650-4e56-b325-86d44688d02b",
   "type":"event.sync.ptp-status.ptp-clock-class-change",
   "source":"/cluster/compute-1.example.com/ptp/ens2fx/master",
   "dataContentType":"application/json",
   "time":"2022-05-06T15:31:23.147100033Z",
   "data":{
      "version":"v1",
      "values":[
         {
            "resource":"/sync/ptp-status/ptp-clock-class-change",
            "dataType":"metric",
            "valueType":"decimal64.3",
            "value":"135"
         }
      ]
   }
}

lock-state 事件示例

{
   "id":"305ec18b-1472-47b3-aadd-8f37933249a9",
   "type":"event.sync.ptp-status.ptp-state-change",
   "source":"/cluster/compute-1.example.com/ptp/ens2fx/master",
   "dataContentType":"application/json",
   "time":"2022-05-06T15:31:23.467684081Z",
   "data":{
      "version":"v1",
      "values":[
         {
            "resource":"/sync/ptp-status/lock-state",
            "dataType":"notification",
            "valueType":"enumeration",
            "value":"LOCKED"
         },
         {
            "resource":"/sync/ptp-status/lock-state",
            "dataType":"metric",
            "valueType":"decimal64.3",
            "value":"62"
         }
      ]
   }
}

gnss-sync-status 事件示例

{
  "id": "435e1f2a-6854-4555-8520-767325c087d7",
  "type": "event.sync.gnss-status.gnss-state-change",
  "source": "/cluster/node/compute-1.example.com/sync/gnss-status/gnss-sync-status",
  "dataContentType": "application/json",
  "time": "2023-09-27T19:35:33.42347206Z",
  "data": {
    "version": "v1",
    "values": [
      {
        "resource": "/cluster/node/compute-1.example.com/ens2fx/master",
        "dataType": "notification",
        "valueType": "enumeration",
        "value": "LOCKED"
      },
      {
        "resource": "/cluster/node/compute-1.example.com/ens2fx/master",
        "dataType": "metric",
        "valueType": "decimal64.3",
        "value": "5"
      }
    ]
  }
}

17.3.6.1.5. api/ocloudNotifications/v1/{resource_address}/CurrentState

HTTP 方法

GET api/ocloudNotifications/v1/cluster/node/<node_name>/sync/ptp-status/lock-state/CurrentState

GET api/ocloudNotifications/v1/cluster/node/<node_name>/sync/sync-status/os-clock-sync-state/CurrentState

GET api/ocloudNotifications/v1/cluster/node/<node_name>/sync/ptp-status/ptp-clock-class-change/CurrentState

描述

配置 CurrentState API 端点，以返回 os-clock-sync-state、ptp-clock-class-change、lock-state 事件的当前状态。

os-clock-sync-state 通知描述了主机操作系统时钟同步状态。可以是 LOCKED 或 FREERUN 状态。
ptp-clock-class-change 通知描述了 PTP 时钟类的当前状态。
lock-state 通知描述了 PTP 设备锁定状态的当前状态。可以处于 LOCKED、HOLDOVER 或 FREERUN 状态。

表 17.14. 全局路径参数
参数	类型
`resource_address`	string

lock-state API 响应示例

{
  "id": "c1ac3aa5-1195-4786-84f8-da0ea4462921",
  "type": "event.sync.ptp-status.ptp-state-change",
  "source": "/cluster/node/compute-1.example.com/sync/ptp-status/lock-state",
  "dataContentType": "application/json",
  "time": "2023-01-10T02:41:57.094981478Z",
  "data": {
    "version": "v1",
    "values": [
      {
        "resource": "/cluster/node/compute-1.example.com/ens5fx/master",
        "dataType": "notification",
        "valueType": "enumeration",
        "value": "LOCKED"
      },
      {
        "resource": "/cluster/node/compute-1.example.com/ens5fx/master",
        "dataType": "metric",
        "valueType": "decimal64.3",
        "value": "29"
      }
    ]
  }
}

os-clock-sync-state API 响应示例

{
  "specversion": "0.3",
  "id": "4f51fe99-feaa-4e66-9112-66c5c9b9afcb",
  "source": "/cluster/node/compute-1.example.com/sync/sync-status/os-clock-sync-state",
  "type": "event.sync.sync-status.os-clock-sync-state-change",
  "subject": "/cluster/node/compute-1.example.com/sync/sync-status/os-clock-sync-state",
  "datacontenttype": "application/json",
  "time": "2022-11-29T17:44:22.202Z",
  "data": {
    "version": "v1",
    "values": [
      {
        "resource": "/cluster/node/compute-1.example.com/CLOCK_REALTIME",
        "dataType": "notification",
        "valueType": "enumeration",
        "value": "LOCKED"
      },
      {
        "resource": "/cluster/node/compute-1.example.com/CLOCK_REALTIME",
        "dataType": "metric",
        "valueType": "decimal64.3",
        "value": "27"
      }
    ]
  }
}

ptp-clock-class-change API 响应示例

{
  "id": "064c9e67-5ad4-4afb-98ff-189c6aa9c205",
  "type": "event.sync.ptp-status.ptp-clock-class-change",
  "source": "/cluster/node/compute-1.example.com/sync/ptp-status/ptp-clock-class-change",
  "dataContentType": "application/json",
  "time": "2023-01-10T02:41:56.785673989Z",
  "data": {
    "version": "v1",
    "values": [
      {
        "resource": "/cluster/node/compute-1.example.com/ens5fx/master",
        "dataType": "metric",
        "valueType": "decimal64.3",
        "value": "165"
      }
    ]
  }
}

17.3.7. 监控 PTP 快速事件指标

您可以从运行 linuxptp-daemon 的集群节点监控 PTP 快速事件指标。您还可以使用预先配置和自我更新的 Prometheus 监控堆栈来监控 OpenShift Container Platform Web 控制台中的 PTP 快速事件指标。

先决条件

安装 OpenShift Container Platform CLI oc。
以具有 cluster-admin 特权的用户身份登录。
在具有 PTP 功能硬件的节点上安装和配置 PTP Operator。

流程

运行以下命令，为节点启动 debug pod：
```
$ oc debug node/<node_name>
```

检查 linuxptp-daemon 容器公开的 PTP 指标。例如，运行以下命令：

sh-4.4# curl http://localhost:9091/metrics

输出示例

# HELP cne_api_events_published Metric to get number of events published by the rest api
# TYPE cne_api_events_published gauge
cne_api_events_published{address="/cluster/node/compute-1.example.com/sync/gnss-status/gnss-sync-status",status="success"} 1
cne_api_events_published{address="/cluster/node/compute-1.example.com/sync/ptp-status/lock-state",status="success"} 94
cne_api_events_published{address="/cluster/node/compute-1.example.com/sync/ptp-status/ptp-clock-class-change",status="success"} 18
cne_api_events_published{address="/cluster/node/compute-1.example.com/sync/sync-status/os-clock-sync-state",status="success"} 27

要在 OpenShift Container Platform web 控制台中查看 PTP 事件，请复制您要查询的 PTP 指标的名称，如 openshift_ptp_offset_ns。
在 OpenShift Container Platform web 控制台中点 Observe Metrics。
将 PTP 指标名称粘贴到 Expression 字段中，然后点 Run query。

其他资源

管理指标

17.3.8. PTP 快速事件指标参考

下表描述了运行 linuxptp-daemon 服务的集群节点可用的 PTP 快速事件指标。

表 17.15. PTP 快速事件指标
指标	描述	Example
`openshift_ptp_clock_class`	返回接口的 PTP 时钟类。对于 PTP 时钟类的可能值为：6 (`LOCKED`), 7 (`PRC UNLOCKED IN-SPEC`), 52 (`PRC UNLOCKED OUT-OF-SPEC`), 187 (`PRC UNLOCKED OUT-OF-SPEC`), 135 (`T-BC HOLDOVER IN-SPEC`), 165 (`T-BC HOLDOVER OUT-OF-SPEC`), 248 (`DEFAULT`), 或 255 (`SLAVE ONLY CLOCK`)。	`{node="compute-1.example.com",process="ptp4l"} 6`
`openshift_ptp_clock_state`	返回接口的当前 PTP 时钟状态。PTP 时钟状态的可能值为 `FREERUN`、`LOCKED` 或 `HOLDOVER`。	`{iface="CLOCK_REALTIME", node="compute-1.example.com", process="phc2sys"} 1`
`openshift_ptp_delay_ns`	返回主时钟发送计时数据包和接收计时数据包之间的延迟（以纳秒为单位）。	`{from="master", iface="ens2fx", node="compute-1.example.com", process="ts2phc"} 0`
`openshift_ptp_ha_profile_status`	当不同 NIC 上有多个时间源时，返回高可用性系统时钟的当前状态。可能的值为 0 (`INACTIVE`) 和 1 (`ACTIVE`)。	`{node="node1",process="phc2sys",profile="profile1"} 1{node="node1",process="phc2sys",profile="profile2"} 0`
`openshift_ptp_frequency_adjustment_ns`	以纳秒为单位返回 2 PTP 时钟之间的频率调整。例如，在上游时钟和 NIC 之间，系统时钟和 NIC 之间，或在 PTP 硬件时钟(`phc`)和 NIC 之间。	`{from="phc", iface="CLOCK_REALTIME", node="compute-1.example.com", process="phc2sys"} -6768`
`openshift_ptp_interface_role`	返回为接口配置的 PTP 时钟角色。可能的值包括 0 (`PASSIVE`), 1 (`SLAVE`), 2 (`MASTER`), 3 (`FAULTY`), 4 (`UNKNOWN`), or 5 (`LISTENING`).	`{iface="ens2f0", node="compute-1.example.com", process="ptp4l"} 2`
`openshift_ptp_max_offset_ns`	返回 2 时钟或接口之间的最大偏移量（以纳秒为单位）。例如，在上游 GNSS 时钟和 NIC (`ts2phc`)之间，或在 PTP 硬件时钟(`phc`)和系统时钟(`phc2sys`)之间。	`{from="master", iface="ens2fx", node="compute-1.example.com", process="ts2phc"} 1.038099569e+09`
`openshift_ptp_offset_ns`	返回 DPLL 时钟或 GNSS 时钟源和 NIC 硬件时钟之间的偏移量。	`{from="phc", iface="CLOCK_REALTIME", node="compute-1.example.com", process="phc2sys"} -9`
`openshift_ptp_process_restart_count`	返回 `ptp4l` 和 `ts2phc` 进程重启的次数。	`{config="ptp4l.0.config", node="compute-1.example.com",process="phc2sys"} 1`
`openshift_ptp_process_status`	返回显示 PTP 进程是否正在运行的状态代码。	`{config="ptp4l.0.config", node="compute-1.example.com",process="phc2sys"} 1`
`openshift_ptp_threshold`	为 `HoldOverTimeout`, `MaxOffsetThreshold`, 和 `MinOffsetThreshold` 返回值。 `holdOverTimeout` 是在 PTP master clock 断开连接时，PTP 时钟事件状态更改为 `FREERUN` 前的时间值（以秒为单位）。 `maxOffsetThreshold` 和 `minOffsetThreshold` 是以纳秒为单位的偏移值，它比较 `CLOCK_REALTIME` (`phc2sys`) 的值，或您在 `PtpConfig` CR 中为 NIC 配置的 r master offset (`ptp4l`) 的值。	`{node="compute-1.example.com", profile="grandmaster", threshold="HoldOverTimeout"} 5`

只有在启用 T-GM 时，PTP 快速事件指标

下表描述了仅在启用 PTP grandmaster 时钟 (T-GM) 时可用的 PTP 快速事件指标。

表 17.16. 启用 T-GM 时的 PTP 快速事件指标
指标	描述	Example
`openshift_ptp_frequency_status`	返回 NIC 的数字阶段锁定循环(DPLL)频率的当前状态。可能的值为 -1 (`UNKNOWN`), 0 (`INVALID`), 1 (`FREERUN`), 2 (`LOCKED`), 3 (`LOCKED_HO_ACQ`), 或 4 (`HOLDOVER`).	`{from="dpll",iface="ens2fx",node="compute-1.example.com",process="dpll"} 3`
`openshift_ptp_nmea_status`	返回 NMEA 连接的当前状态。NMEA 是 1PPS NIC 连接使用的协议。可能的值有 0 (`UNAVAILABLE`) 和 1 (`AVAILABLE`)。	`{iface="ens2fx",node="compute-1.example.com",process="ts2phc"} 1`
`openshift_ptp_phase_status`	返回 NIC 的 DPLL 阶段的状态。可能的值为 -1 (`UNKNOWN`), 0 (`INVALID`), 1 (`FREERUN`), 2 (`LOCKED`), 3 (`LOCKED_HO_ACQ`), 或 4 (`HOLDOVER`).	`{from="dpll",iface="ens2fx",node="compute-1.example.com",process="dpll"} 3`
`openshift_ptp_pps_status`	返回 NIC 1PPS 连接的当前状态。您可以使用 1PPS 连接在连接的 NIC 之间同步计时。可能的值有 0 (`UNAVAILABLE`) 和 1 (`AVAILABLE`)。	`{from="dpll",iface="ens2fx",node="compute-1.example.com",process="dpll"} 1`
`openshift_ptp_gnss_status`	返回全局导航 Satellite 系统(GNSS)连接的当前状态。GNSS 在全局范围内提供基于 satellite 的位置、导航和计时服务。可能的值包括 0 (`NOFIX`), 1 (`DEAD RECKONING ONLY`), 2 (`2D-FIX`), 3 (`3D-FIX`), 4 (`GPS+DEAD RECKONING FIX`), 5, (`TIME ONLY FIX`).	`{from="gnss",iface="ens2fx",node="compute-1.example.com",process="gnss"} 3`

17.3.1. 关于 PTP 和时钟同步错误事件

17.3.2. 关于 PTP 快速事件通知框架

17.3.3. 配置 PTP 快速事件通知发布程序

17.3.4. 迁移消费者应用程序，以使用 PTP 或裸机事件的 HTTP 传输

17.3.5. 安装 AMQ 消息传递总线

17.3.6. 使用 REST API 将 DU 应用程序订阅到 PTP 事件

17.3.6.1. PTP 事件 REST API 参考

17.3.6.1.1. api/ocloudNotifications/v1/subscriptions

HTTP 方法

描述

HTTP 方法

描述

HTTP 方法

描述

17.3.6.1.2. api/ocloudNotifications/v1/subscriptions/{subscription_id}

HTTP 方法

描述

HTTP 方法

描述

17.3.6.1.3. api/ocloudNotifications/v1/health

HTTP 方法

描述

17.3.6.1.4. api/ocloudNotifications/v1/publishers

HTTP 方法

描述

17.3.6.1.5. api/ocloudNotifications/v1/{resource_address}/CurrentState

HTTP 方法

描述

17.3.7. 监控 PTP 快速事件指标

17.3.8. PTP 快速事件指标参考

只有在启用 T-GM 时，PTP 快速事件指标

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links