fix issues related to UTC time, fixes #194

Author: duncanpo

api/logs/+opentelemetry/+logs/Logger.m

@@ -1,7 +1,7 @@
 classdef Logger < handle
     % A logger that is used to emit log records
 
-    % Copyright 2024 The MathWorks, Inc.
+    % Copyright 2024-2025 The MathWorks, Inc.
 
     properties (SetAccess=immutable)
         Name    (1,1) string   % Logger name
@@ -38,7 +38,9 @@ function emitLogRecord(obj, severity, body, trailingnames, trailingvalues)
             %    Parameters are:
             %       "Context"   - Span contained in a context object.
             %       "Timestamp" - Timestamp of the log record specified as a
-            %                     datetime. Default is the current time.
+            %                     datetime. Default is the current time. If
+            %                     Timestamp does not have a time zone 
+            %                     specified, it is interpreted as a UTC time.
             %       "Attributes" - Attribute name-value pairs specified as
             %                      a dictionary.
             %

api/trace/+opentelemetry/+trace/Span.m

@@ -1,7 +1,7 @@
 classdef Span < handle
 % A span that represents a unit of work within a trace.  
 
-% Copyright 2023-2024 The MathWorks, Inc.
+% Copyright 2023-2025 The MathWorks, Inc.
 
     properties 
         Name  (1,1) string   % Name of span
@@ -42,6 +42,10 @@ function endSpan(obj, endtime)
             % ENDSPAN  End the span.
             %    ENDSPAN(SP) ends the span SP.
             %
+            %    ENDSPAN(SP, ENDTIME) also specifies the end time. If
+            %    ENDTIME does not have a time zone specified, it is
+            %    interpreted as a UTC time.
+            %
             %    See also OPENTELEMETRY.TRACE.TRACER.STARTSPAN
             if nargin < 2
                 obj.Proxy.endSpan();
@@ -99,7 +103,9 @@ function addEvent(obj, eventname, varargin)
             %    ADDEVENT(SP, NAME) records a event with the specified name
             %    at the current time.
             %
-            %    ADDEVENT(SP, NAME, TIME) also specifies a event time.
+            %    ADDEVENT(SP, NAME, TIME) also specifies a event time. If
+            %    TIME does not have a time zone specified, it is
+            %    interpreted as a UTC time.
             %
             %    ADDEVENT(..., ATTRIBUTES) or ADDEVENT(..., ATTRNAME1,
             %    ATTRVALUE1, ATTRNAME2, ATTRVALUE2, ...) specifies
@@ -113,7 +119,7 @@ function addEvent(obj, eventname, varargin)
                 eventtime = posixtime(varargin{1});
                 varargin(1) = [];  % remove the time input from varargin
             else
-                eventtime = posixtime(datetime("now"));
+                eventtime = posixtime(datetime("now", "TimeZone", "UTC"));
             end
 
             eventname = opentelemetry.common.mustBeScalarString(eventname);

api/trace/+opentelemetry/+trace/Tracer.m

@@ -1,7 +1,7 @@
 classdef Tracer < handle
     % A tracer that is used to create spans.
 
-    % Copyright 2023-2024 The MathWorks, Inc.
+    % Copyright 2023-2025 The MathWorks, Inc.
 
     properties (SetAccess=immutable)
         Name    (1,1) string   % Tracer name
@@ -37,7 +37,9 @@
             %       "SpanKind"  - "server", "client", "producer",
             %                     "consumer", or "internal" (default)
             %       "StartTime" - Starting time of span specified as a
-            %                     datetime. Default is the current time.
+            %                     datetime. Default is the current time. If
+            %                     StartTime does not have a time zone 
+            %                     specified, it is interpreted as a UTC time.
             %       "Attributes" - Attribute name-value pairs specified as
             %                      a dictionary.
             %       "Links"     - Link objects that specifies relationships

test/tlogs.m

@@ -285,15 +285,15 @@ function testTimestamp(testCase)
             % testTimestamp: specifying a timestamp
             lp = opentelemetry.sdk.logs.LoggerProvider();
             lg = getLogger(lp, "foo");
-            timestamp = datetime(2020,3,12,9,45,0);
+            timestamp = datetime(2020,3,12,9,45,0, "TimeZone", "UTC");
             emitLogRecord(lg, "info", "bar", "Timestamp", timestamp);
 
             % perform test comparisons
             forceFlush(lp, testCase.ForceFlushTimeout);
             results = readJsonResults(testCase);
             verifyEqual(testCase, datetime(double(string(...
                 results{1}.resourceLogs.scopeLogs.logRecords.timeUnixNano))/1e9, ...
-                "convertFrom", "posixtime"), timestamp);  % convert from nanoseconds to seconds
+                "convertFrom", "posixtime", "TimeZone", "UTC"), timestamp);  % convert from nanoseconds to seconds
         end
 
         function testAttributes(testCase)

test/ttrace.m

@@ -323,20 +323,20 @@ function testTime(testCase)
             % testTime: specifying start and end times
             tp = opentelemetry.sdk.trace.TracerProvider();
             tr = getTracer(tp, "tracer");
-            starttime = datetime(2000,1,1,10,0,0);
-            endtime = datetime(2001, 8, 31, 7, 30, 0);
+            starttime = datetime(2000,1,1,10,0,0, "TimeZone", "UTC");
+            endtime = datetime(2001, 8, 31, 7, 30, 0, "TimeZone", "UTC");
             sp = startSpan(tr, "foo", "StartTime", starttime);
             endSpan(sp, endtime);
 
             % perform test comparisons
             results = readJsonResults(testCase);
             verifyEqual(testCase, datetime(double(string(...
                 results{1}.resourceSpans.scopeSpans.spans.startTimeUnixNano))/1e9, ...
-                "convertFrom", "posixtime"), starttime);  % convert from nanoseconds to seconds
+                "convertFrom", "posixtime", "TimeZone", "UTC"), starttime);  % convert from nanoseconds to seconds
             % for end time, use a tolerance
             verifyLessThanOrEqual(testCase, abs(datetime(double(string(...
                 results{1}.resourceSpans.scopeSpans.spans.endTimeUnixNano))/1e9, ...
-                "convertFrom", "posixtime") - endtime), seconds(2));
+                "convertFrom", "posixtime", "TimeZone", "UTC") - endtime), seconds(2));
         end
 
         function testStatus(testCase)
@@ -551,17 +551,24 @@ function testEvents(testCase)
             nvattributes = {"doublescalar", 5, "int32array", reshape(int32(1:6),2,3), ...
                 "stringscalar", "baz"};
             addEvent(sp, "baz", nvattributes{:});
+            event1time = datetime("now", "TimeZone", "UTC");
             % dictionary
             attributes = dictionary(["doublearray", "int64scalar", "stringarray"], ...
                 {reshape(1:4,1,2,2), int64(350), ["one", "two", "three"; "four", "five","six"]});
             addEvent(sp, "quux", attributes);
+            event2time = datetime("now", "TimeZone", "UTC");
             endSpan(sp);
 
             results = readJsonResults(testCase);
             nvattributesstruct = struct(nvattributes{:});
 
+            tol = seconds(2);  % tolerance for testing times
+
             % event 1
             verifyEqual(testCase, results{1}.resourceSpans.scopeSpans.spans.events(1).name, 'baz');
+            verifyLessThanOrEqual(testCase, abs(datetime(double(string(...
+                results{1}.resourceSpans.scopeSpans.spans.events(1).timeUnixNano))/1e9, ...
+                "convertFrom", "posixtime", "TimeZone", "UTC") - event1time), tol);
 
             event1keys = string({results{1}.resourceSpans.scopeSpans.spans.events(1).attributes.key});
 
@@ -587,6 +594,9 @@ function testEvents(testCase)
 
             % event 2
             verifyEqual(testCase, results{1}.resourceSpans.scopeSpans.spans.events(2).name, 'quux');
+            verifyLessThanOrEqual(testCase, abs(datetime(double(string(...
+                results{1}.resourceSpans.scopeSpans.spans.events(2).timeUnixNano))/1e9, ...
+                "convertFrom", "posixtime", "TimeZone", "UTC") - event2time), tol);
 
             event2keys = string({results{1}.resourceSpans.scopeSpans.spans.events(2).attributes.key});