Telemetry logservice URI format | Redfish Specification Forum

AMI_Mani
Tuna

AMI

Posts: 175

Telemetry logservice URI format Apr 1, 2020 12:09:58 GMT

Quote

Post by AMI_Mani on Apr 1, 2020 12:09:58 GMT

Hi,

As per LogEntry_v1.xml(DSP8010_2019.4), TelemetryService logservice uri is mentioned as /redfish/v1/TelemetryService/LogService/Entries/{LogEntryId} which is different from other logservices uri format (/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries/{LogEntryId})

Is TelemetryService logservice uri needs to be /redfish/v1/TelemetryService/LogService/Entries/{LogEntryId} or /redfish/v1/TelemetryService/LogServices/{LogServiceId}/Entries/{LogEntryId}, please confirm

<Annotation Term="Redfish.Uris">
<Collection>
<String>/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries/{LogEntryId}</String>
<String>/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}</String>
<String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}</String>
<String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}</String>
<String>/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries/{LogEntryId}</String>
<String>/redfish/v1/JobService/Log/Entries/{LogEntryId}</String>
<String>/redfish/v1/TelemetryService/LogService/Entries/{LogEntryId}</String>
</Collection>
</Annotation>
</EntityType>

Thanks,
Mani

Last Edit: Apr 1, 2020 12:10:20 GMT by AMI_Mani

jautor
Administrator

Posts: 502

Telemetry logservice URI format Apr 1, 2020 14:54:32 GMT

Quote

Post by jautor on Apr 1, 2020 14:54:32 GMT

Yes, it is different, and it is correct.

A Manager or a ComputerSystem can (and frequently do) have multiple logs, either for different purposes or because they are being reported from different sources and can't be combined easily. So Redfish allows for a collection of Log Services (a resource collection of LogService) under Manager or ComputerSystem to support that very typical implementation.

When we added the Telemetry Service, we made the design decision to limit it to a single Log (Log Service) if one existed at all, making the reasonable assumption that there was no need for multiple logs dedicated to a single service (telemetry, in this case). That simplifies the design for the end user significantly, as it allows a single LogService instance to be available directly under TelemetryService. And as the model expands to other areas, we would expect to see more usage of a single-log-per-service design pattern for that reason.

Which is why the URI pattern is different for the TelemetryService LogService (singular) compared to the Manager LogServices (plural). In Redfish naming, the plural form is used to indicate a Resource Collection...

Hope that makes sense,

Jeff

mraineri
Administrator

Posts: 1,049

Member is Online

Telemetry logservice URI format Apr 2, 2020 18:21:45 GMT

Quote

Post by mraineri on Apr 2, 2020 18:21:45 GMT

The other thing to keep in mind is typically the manager that implements the telemetry service will own the logging responsibilities. The manager might have allocated a dedicated log service in its own collection for this, combined it with one of its other logs, or provisioned it directly within the telemetry service.

So, something like this is valid:

{
    "@odata.id": "/redfish/v1/TelemetryService",
    "Id": "TelemetryService",
    "Name": "Telemetry Service",
    "MetricReports": { ... },
    "LogService": {
        "@odata.id": "/redfish/v1/Managers/1/LogServices/TelemetryLogs"
    }
}

Last Edit: Apr 2, 2020 18:22:22 GMT by mraineri