Skip to content

Commit 0cd9e5b

Browse files
[DOCS] clarify logger format handling (#4149)
1 parent 58d4197 commit 0cd9e5b

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎api/include/opentelemetry/logs/logger.h‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,8 +430,11 @@ class Logger
430430
*
431431
* @param severity severity of the log
432432
* @param event_id event identifier of the log
433-
* @param format an utf-8 string following https://messagetemplates.org/
433+
* @param format a UTF-8 string stored as the log record body
434434
* @param attributes key value pairs of the log
435+
*
436+
* @note The @p format string is not interpolated with values from
437+
* @p attributes. Pass structured data through @p attributes.
435438
*/
436439
virtual void Log(Severity severity,
437440
const EventId &event_id,

0 commit comments

Comments
 (0)