ISSUE链接
【需求】可观测新增redfish、web接口及属性-rackmount-GitCode
背景
为提高系统监控和故障排查效率，优化用户体验，基于openTelemetry规范完成可观测能力实现，提供北向接口支持用户查询与设置可观测服务的配置
决策点
1.是否同意新增web查询与设置接口
接口名：/UI/Rest/ObservabilityService
属性名：ServiceEnabled、TLSMode、Receivers、Id、Enabled、Address、Port
2.是否同意新增web测试功能接口
接口名：/UI/Rest/ObservabilityService/SubmitTestTelemetryData
属性名：ReceiverId
3.是否同意新增资源树属性
资源树path：/bmc/kepler/ObservabilityService
资源树intf：bmc.kepler.ObservabilityService
属性：Enabled、TLSMode
资源树path：/bmc/kepler/ObservabilityService/Receivers/:Id
资源树intf：bmc.kepler.ObservabilityService.Receiver
属性：ReceiverId、Enabled、Address、Port
Method：SubmitTestTelemetryData
详细描述
一、可观测服务查询与设置接口
URI：/UI/Rest/ObservabilityService
变化类型：新增URI
操作类型： GET/PATCH
应用场景：用户更改可观测相关配置
| 属性名称 | 取值类型 | 取值范围 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ServiceEnabled | boolean | true/false | false | DiagnoseMgmt | 可观测服务使能状态 |
| TLSMode | string | TLS（单向TLS认证）、mTLS（双向TLS认证）备选：OneWay（单向）、TwoWay（双向） | TLS | DiagnoseMgmt | 可观测服务认证方式，必须使用证书认证 |
| Receivers | array | 当前只支持一个接收端，预留拓展能力 | |||
| Id | integer | 0 | 0 | DiagnoseMgmt | 接收端序号 |
| Enabled | boolean | true/false | false | DiagnoseMgmt | 接收端使能状态 |
| Address | String | ipv4、ipv6和域名地址 | “” | DiagnoseMgmt | 接收端地址，默认值为空 |
| Port | integer | 1-65535 | 0 | DiagnoseMgmt | 接收端端口 |
二、可观测服务测试接口
URI：/UI/Rest/ObservabilityService/SubmitTestTelemetryData
变化类型：新增URI
操作类型： POST
应用场景：用户进行可观测功能服务测试
| 属性名称 | 取值类型 | 取值范围 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ReceiverId | integer | 0 | NA | DiagnoseMgmt | 接收端序号 |
三、可观测服务资源树接口
（1）
资源path：/bmc/kepler/ObservabilityService
资源interface：bmc.kepler.ObservabilityService
变化类型：新增接口/属性
应用场景：用户更改可观测相关配置
持久化类型：掉电持久化
操作权限：DiagnoseMgmt
| 属性名称 | 签名 | 变化通知 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| Enabled | b | true | false | DiagnoseMgmt | 可观测服务使能状态 |
| TLSMode | s | true | TLS | DiagnoseMgmt | 可观测服务认证方式，必须使用证书认证，取值范围为TLS（单向认证）和mTLS（双向认证）备选：OneWay（单向）、TwoWay（双向） |
（2）
资源path：/bmc/kepler/ObservabilityService/Receivers/:Id
资源interface：bmc.kepler.ObservabilityService.Receiver
变化类型：新增接口/属性
应用场景：用户更改可观测相关配置
持久化类型：掉电持久化
操作权限：DiagnoseMgmt
| 属性名称 | 签名 | 变化通知 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ReceiverId | y | true | DiagnoseMgmt | 接收端序号，当前只有一个接收端，固定为1 | |
| Enabled | b | true | false | DiagnoseMgmt | 接收端使能状态 |
| Address | s | true | “” | DiagnoseMgmt | 接收端地址，约束需要符合ipv4、ipv6和域名地址格式，默认值为空 |
| Port | q | true | 0 | DiagnoseMgmt | 接收端端口，默认值为0，取值范围为[1,65535] |
| 方法名称 | req签名 | 请求参数 | 操作权限 | 说明 |
|---|---|---|---|---|
| SubmitTestTelemetryData | NA | NA | DiagnoseMgmt | 可观测服务测试接口 |
评审结论
一、
同意新增web查询与设置接口
接口名：/UI/Rest/ObservabilityService
| 属性名称 | 取值类型 | 取值范围 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ServiceEnabled | boolean | true/false | false | DiagnoseMgmt | 可观测服务使能状态 |
| TLSMode | string | TLS（单向TLS认证）、mTLS（双向TLS认证 | TLS | DiagnoseMgmt | 可观测服务认证方式，必须使用证书认证 |
| Receivers | array | 当前只支持一个接收端，预留拓展能力 | |||
| Id | integer | 0 | 0 | DiagnoseMgmt | 接收端序号 |
| Enabled | boolean | true/false | false | DiagnoseMgmt | 接收端使能状态 |
| Address | String | ipv4、ipv6和域名地址 | “” | DiagnoseMgmt | 接收端地址，可为空 |
| Port | integer | 1-65535 | 0 | DiagnoseMgmt | 接收端端口 |
| Protocol | String | “OtlpHttp” | “OtlpHttp” | DiagnoseMgmt | 可观测服务支持的协议与数据格式 |
二、
同意新增web测试功能接口
接口名：/UI/Rest/ObservabilityService/SubmitTestTelemetryData
| 属性名称 | 取值类型 | 取值范围 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ReceiverId | integer | 0 | NA | DiagnoseMgmt | 接收端序号 |
三、
同意新增资源树属性
资源树path：/bmc/kepler/ObservabilityService
资源树intf：bmc.kepler.ObservabilityService
属性：Enabled、TLSMode
| 属性名称 | 签名 | 变化通知 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| Enabled | b | true | false | DiagnoseMgmt | 可观测服务使能状态 |
| TLSMode | s | true | TLS | DiagnoseMgmt | 可观测服务认证方式，必须使用证书认证，取值范围为TLS（单向认证）和mTLS（双向认证） |
资源树path：/bmc/kepler/ObservabilityService/Receivers/:Id
资源树intf：bmc.kepler.ObservabilityService.Receiver
属性：ReceiverId、Enabled、Address、Port、Protocol
Method：SubmitTestTelemetryData
| 属性名称 | 签名 | 变化通知 | 默认值 | 操作权限 | 说明 |
|---|---|---|---|---|---|
| ReceiverId | y | true | DiagnoseMgmt | 接收端序号，当前只有一个接收端，固定为1 | |
| Enabled | b | true | false | DiagnoseMgmt | 接收端使能状态 |
| Address | s | true | “” | DiagnoseMgmt | 接收端地址，约束需要符合ipv4、ipv6和域名地址格式，默认值为空 |
| Port | q | true | 0 | DiagnoseMgmt | 接收端端口，默认值为0，取值范围为[1,65535] |
| Protocol | s | true | “OtlpHttp” | DiagnoseMgmt | 可观测服务支持的协议与数据格式 |
| 方法名称 | req签名 | 请求参数 | 操作权限 | 说明 |
|---|---|---|---|---|
| SubmitTestTelemetryData | NA | NA | DiagnoseMgmt | 可观测服务测试接口 |