ResourceDefinition

uris

/redfish/v1/Oem/Public/ObservabilityService

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true		可观测服务资源模型的Odata描述信息
@odata.id	string	true		可观测服务资源节点的访问路径
@odata.type	string	true		可观测服务资源类型
Id	string	true		可观测服务资源的ID
Name	string	true		可观测服务资源的名称
ServiceEnabled	boolean	false		服务端是否使能
TLSMode	string	false	TLS、mTLS	TLS模式
ServerIdentity	string	false	BoardSN、ProductAssetTag、HostName	主机标识，用于标识遥测数据信息来源
Traces	object	false		跟踪数据配置
Traces.SamplingRate	number	false		跟踪采样率
Traces.SupportedSamplingRate	array	true		当前版本支持的跟踪采样率，当前支持：0.1、0.05、0.01、0.005、0.001、0
Traces.SamplingPolicy	string	false	Fixed、Adaptive	跟踪采样策略
Traces.SamplingLevel	string	false	System、Component、Function	跟踪分级策略
Traces.ExportIntervalSeconds	number	false		跟踪数据上报周期
Metrics	object	false		指标数据配置
Metrics.ExportIntervalSeconds	number	false		指标数据上报周期
Metrics.SupportedMetrics	array	true		当前版本支持的各度量指标名称
Metrics.ActivatedMetrics	array	false		各度量指标使能开关
Logs	object	false		日志数据配置
Logs.Enabled	boolean	false		日志采集使能
Logs.ExportIntervalSeconds	number	false		日志数据上报周期
Receivers	array	false		接收端资源
Receivers[].ReceiverId	number	false		接收端序号，当前只支持为0
Receivers[].Enabled	boolean	false		接收端使能
Receivers[].Address	string	false		接收端地址
Receivers[].Port	number	false		接收端端口
Receivers[].Protocol	string	false	OtlpHttp	接收端协议

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询可观测服务配置资源

说明

BMC300 5.10.0.1及以上版本，当前只针对BMC系统提供可观测服务能力

命令格式

URL: https://device_ip/redfish/v1/Oem/Public/ObservabilityService

请求头:


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
auth_value	执行该请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/Oem/Public/ObservabilityService

请求头：


X-Auth-Token: ******

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#ObservabilityService.ObservabilityService",
  "@odata.id": "/redfish/v1/Oem/Public/ObservabilityService",
  "@odata.type": "#ObservabilityService.v1_0_0.ObservabilityService",
  "Id": "ObservabilityService",
  "Name": "ObservabilityService ",
  "ServiceEnabled": true,
  "TLSMode": "TLS",
  "ServerIdentity": "BoardSN",
  "Traces": {
    "SamplingRate": 0.1,
    "SupportedSamplingRate": [
      0.1,
      0.05,
      0.01,
      0.005,
      0.001
    ],
    "SamplingPolicy": "Fixed",
    "SamplingLevel": "System",
    "ExportIntervalSeconds": 20
  },
  "Metrics": {
    "ExportIntervalSeconds": 30,
    "SupportedMetrics": [
      "bmc.hw.chip.io",
      "bmc.hw.chip.accessor",
      "bmc.hw.chip.scanner",
      "bmc.mc.flash.io",
      "bmc.rpc.client.request",
      "bmc.persistence.server.request",
      "bmc.persistence.flash.io",
      "bmc.broadcast.producer.send",
      "bmc.system.uptime",
      "bmc.system.cpu.usage",
      "bmc.system.memory.usage",
      "bmc.process.cpu.usage",
      "bmc.process.memory.usage",
      "bmc.system.flash.io",
      "bmc.system.flash.lifeleft"
    ],
    "ActivatedMetrics": [
      "bmc.hw.chip.io",
      "bmc.hw.chip.accessor"
    ]
  },
  "Logs": {
    "Enabled": false,
    "ExportIntervalSeconds": 20
  },
  "Receivers": [
    {
      "ReceiverId": 0,
      "Enabled": true,
      "Address": "100.100.100.100",
      "Port": 1234,
      "Protocol": "OtlpHttp"
    }
  ],
  "Actions": {
    "ObservabilityService.SubmitTestTelemetryData": {
      "target": "/redfish/v1/Oem/Public/ObservabilityService/Actions/ObservabilityService.SubmitTestTelemetryData",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Public/ObservabilityService/SubmitTestTelemetryDataActionInfo"
    }
  }
}

响应码：200

PATCH

命令功能

设置可观测服务配置资源

说明

BMC300 5.10.0.1及以上版本，当前只针对BMC系统提供可观测服务能力

命令格式

URL: https://device_ip/redfish/v1/Oem/Public/ObservabilityService

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
  "ServiceEnabled": service_enabled,
  "TLSMode": TLS_mode,
  "ServerIdentity": server_identity,
  "Traces": {
    "SamplingRate": sampling_rate,
    "SamplingPolicy": sampling_policy,
    "SamplingLevel": sampling_level,
    "ExportIntervalSeconds": traces_export_interval_seconds
  },
  "Metrics": {
    "ExportIntervalSeconds": metrics_export_interval_seconds,
    "ActivatedMetrics": activate_metrics
  },
  "Logs": {
    "Enabled": logs_enabled,
    "ExportIntervalSeconds": logs_export_interval_seconds
  },
  "Receivers": [
    {
      "Enabled": receiver_enabled,
      "Address": receiver_address,
      "Port": receiver_port,
      "Protocol": receiver_protocol
    }
  ]
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET操作，从响应头中获取（对应于"ETag"参数）
service_enabled	可观测服务使能状态	● true: 开启 ● false: 关闭
TLS_mode	TLS模式	● TLS: 单向认证 ● mTLS: 双向认证
server_identity	主机标识，用于标识遥测数据信息来源	● BoardSN：单板序列号 ● ProductAssetTag：产品资产标签 ● HostName：主机名
sampling_rate	跟踪采样率	取值范围[0.1, 0.05, 0.01, 0.005, 0.001, 0] 取值为0时表示跟踪采样和上报使能关闭
sampling_policy	跟踪采样策略	● Fixed：固定采样，使用指定的采样率进行采样 ● Adaptive：自适应采样，根据cpu占用率自适应调整采样率
sampling_level	跟踪分级策略	● System：系统级采样，BMC系统间通信的调用过程 ● Component：组件级采样，组件间通信的调用过程 ● Function：功能级采样，组件内部业务功能的调用过程
traces_export_interval_seconds	跟踪数据上报周期	单位为秒，取值范围[10,30]
metrics_export_interval_seconds	指标数据上报周期	单位为秒，取值范围[30,3600]
activate_metrics	各度量指标使能开关	字符串数组，取值范围：bmc.hw.chip.io、bmc.hw.chip.accessor、bmc.hw.chip.scanner、bmc.mc.flash.io、bmc.rpc.client.request、bmc.persistence.server.request、bmc.persistence.flash.io、bmc.broadcast.producer.send、bmc.system.uptime、bmc.system.cpu.usage、bmc.system.memory.usage、bmc.process.cpu.usage、bmc.process.memory.usage、bmc.system.flash.io、bmc.system.flash.lifeleft
logs_enabled	日志采集使能	● true: 开启 ● false: 关闭
logs_export_interval_seconds	日志数据上报周期	单位为秒，取值范围[10,30]
receiver_enabled	接收端使能状态	● true: 开启 ● false: 关闭
receiver_address	接收端地址	Ipv4,Ipv6或者域名
receiver_port	接收端端口	1-65535
receiver_protocol	接收端协议	OtlpHttp

使用指南

无

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/Oem/Public/ObservabilityService

请求头：


X-Auth-Token: ******
Content-Type: application/json
If-Match: W/"bc428df5"

请求消息体：

json

{
  "ServiceEnabled": true,
  "TLSMode": "TLS",
  "ServerIdentity": "BoardSN",
  "Traces": {
    "SamplingRate": 0.1,
    "SamplingPolicy": "Fixed",
    "SamplingLevel": "System",
    "ExportIntervalSeconds": 20
  },
  "Metrics": {
    "ExportIntervalSeconds": 30,
    "ActivatedMetrics": [
      "bmc.hw.chip.io",
      "bmc.hw.chip.accessor"
    ]
  },
  "Logs": {
    "Enabled": false,
    "ExportIntervalSeconds": 20
  },
  "Receivers": [
    {
      "Enabled": true,
      "Address": "100.100.100.100",
      "Port": 1234,
      "Protocol": "OtlpHttp"
    }
  ]
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#ObservabilityService.ObservabilityService",
  "@odata.id": "/redfish/v1/Oem/Public/ObservabilityService",
  "@odata.type": "#ObservabilityService.v1_0_0.ObservabilityService",
  "Id": "ObservabilityService",
  "Name": "ObservabilityService",
  "ServiceEnabled": true,
  "TLSMode": "TLS",
  "ServerIdentity": "BoardSN",
  "Traces": {
    "SamplingRate": 0.1,
    "SupportedSamplingRate": [
      0.1,
      0.05,
      0.01,
      0.005,
      0.001
    ],
    "SamplingPolicy": "Fixed",
    "SamplingLevel": "System",
    "ExportIntervalSeconds": 20
  },
  "Metrics": {
    "ExportIntervalSeconds": 30,
    "SupportedMetrics": [
      "bmc.hw.chip.io",
      "bmc.hw.chip.accessor",
      "bmc.hw.chip.scanner",
      "bmc.mc.flash.io",
      "bmc.rpc.client.request",
      "bmc.persistence.server.request",
      "bmc.persistence.flash.io",
      "bmc.broadcast.producer.send",
      "bmc.system.uptime",
      "bmc.system.cpu.usage",
      "bmc.system.memory.usage",
      "bmc.process.cpu.usage",
      "bmc.process.memory.usage",
      "bmc.system.flash.io",
      "bmc.system.flash.lifeleft"
    ],
    "ActivatedMetrics": [
      "bmc.hw.chip.io",
      "bmc.hw.chip.accessor"
    ]
  },
  "Logs": {
    "Enabled": false,
    "ExportIntervalSeconds": 20
  },
  "Receivers": [
    {
      "ReceiverId": 0,
      "Enabled": true,
      "Address": "100.100.100.100",
      "Port": 1234,
      "Protocol": "OtlpHttp"
    }
  ],
  "Actions": {
    "ObservabilityService.SubmitTestTelemetryData": {
      "target": "/redfish/v1/Oem/Public/ObservabilityService/Actions/ObservabilityService.SubmitTestTelemetryData",
      "@Redfish.ActionInfo": "/redfish/v1/Oem/Public/ObservabilityService/SubmitTestTelemetryDataActionInfo"
    }
  }
}

响应码：200

POST (ACTION)

SubmitTestTelemetryData

命令功能

发送可观测服务测试报文

说明

BMC300 5.10.0.1及以上版本，当前只针对BMC系统提供可观测服务能力

命令格式

URL: https://device_ip/redfish/v1/Oem/Public/ObservabilityService/Actions/ObservabilityService.SubmitTestTelemetryData

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{
  "ReceiverId": receiver_id
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
receiver_id	报文接收端的序号	0

使用指南

无

使用实例

请求样例：

http

POST https://device_ip/redfish/v1/Oem/Public/ObservabilityService/Actions/ObservabilityService.SubmitTestTelemetryData

请求头：


X-Auth-Token: ******
Content-Type: application/json

请求消息体：

json

{
  "ReceiverId": 0
}

响应样例：

json

{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

SubmitTestTelemetryData ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

SubmitTestTelemetryData