Merge pull request #197 from mathworks/timestamps

duncanpo · web-flow · commit f66398e02c4e · 2025-07-10T10:34:46.000-04:00
Fix two bugs related to Timestamps, fixes #193, fixes #194
diff --git a/.github/workflows/build_and_test_full.yml b/.github/workflows/build_and_test_full.yml
@@ -9,7 +9,7 @@ env:
   MLM_LICENSE_TOKEN: ${{ secrets.MLM_LICENSE_TOKEN }}
 jobs:
     get_version:
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         outputs:
           version: ${{ steps.getversion.outputs.latest_tag }}
         steps:
@@ -25,9 +25,7 @@ jobs:
               working-directory: opentelemetry-matlab
               run: echo "latest_tag=$(sed -re 's/^v?([[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+)?.*/\1/' <<< $(git describe --tags --abbrev=0))" >> $GITHUB_OUTPUT
     build-and-run-tests-ubuntu:
-        # Running on ubuntu-latest would use a glibc version that is incompatible when using the built mex files on a Debian 11 
-        # Instead, run on ubuntu-20.04
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         needs: get_version
         env:
             OPENTELEMETRY_MATLAB_INSTALL: "${{ github.workspace }}/otel_matlab_install"
@@ -57,9 +55,7 @@ jobs:
               with:
                  select-by-folder: opentelemetry-matlab/test
     code-coverage-build-and-run-tests-ubuntu:
-        # Running on ubuntu-latest would use a glibc version that is incompatible when using the built mex files on a Debian 11 
-        # Instead, run on ubuntu-20.04
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         needs: get_version
         env:
             OPENTELEMETRY_MATLAB_INSTALL: "${{ github.workspace }}/otel_matlab_install"
diff --git a/.github/workflows/build_and_test_simple.yml b/.github/workflows/build_and_test_simple.yml
@@ -10,7 +10,7 @@ env:
   MLM_LICENSE_TOKEN: ${{ secrets.MLM_LICENSE_TOKEN }}
 jobs:
     get_version:
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         outputs:
           version: ${{ steps.getversion.outputs.latest_tag }}
         steps:
@@ -26,9 +26,7 @@ jobs:
               working-directory: opentelemetry-matlab
               run: echo "latest_tag=$(sed -re 's/^v?([[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+)?.*/\1/' <<< $(git describe --tags --abbrev=0))" >> $GITHUB_OUTPUT
     build-and-run-tests-ubuntu:
-        # Running on ubuntu-latest would use a glibc version that is incompatible when using the built mex files on a Debian 11 
-        # Instead, run on ubuntu-20.04
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         needs: get_version
         env:
             OPENTELEMETRY_MATLAB_INSTALL: "${{ github.workspace }}/otel_matlab_install"
diff --git a/.github/workflows/create_release.yml b/.github/workflows/create_release.yml
@@ -5,9 +5,7 @@ on:
         - '[0-9]+.[0-9]+.[0-9]+'
 jobs:
     build-ubuntu:
-        # Running on ubuntu-latest would use a glibc version that is incompatible when using the built mex files on a Debian 11 
-        # Instead, run on ubuntu-20.04
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         env:
             OPENTELEMETRY_MATLAB_INSTALL: "${{ github.workspace }}/otel_matlab_install"
         steps:
@@ -97,7 +95,7 @@ jobs:
                 path: ${{ github.workspace }}/otel-matlab-${{ matrix.os }}.tar.gz
     package-mltbx:
         name: Package MATLAB Toolbox (MLTBX) Files
-        runs-on: ubuntu-20.04
+        runs-on: ubuntu-22.04
         permissions:
           contents: write
         needs:
diff --git a/api/logs/+opentelemetry/+logs/Logger.m b/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.
             %
diff --git a/api/logs/src/LoggerProxy.cpp b/api/logs/src/LoggerProxy.cpp
@@ -9,6 +9,7 @@
 #include "opentelemetry/logs/log_record.h"
 #include "opentelemetry/trace/context.h"
 #include "opentelemetry/context/context.h"
+#include "opentelemetry/common/timestamp.h"
 
 #include "MatlabDataArray.hpp"
 
@@ -40,6 +41,12 @@ void LoggerProxy::emitLogRecord(libmexclass::proxy::method::Context& context) {
 
     nostd::unique_ptr<logs_api::LogRecord> rec = CppLogger->CreateLogRecord();
 
+    // Do not use the default timestamp, which is set to the start of UNIX epoch. Set both the 
+    // default timestamp and default observed timestamp to the current time
+    auto now = common::SystemTimestamp(std::chrono::system_clock::now());
+    rec->SetTimestamp(now);
+    rec->SetObservedTimestamp(now);
+
     // Add size attribute if body is nonscalar
     if (array_body) {
        rec->SetAttribute(bodyattrs.Attributes.back().first, bodyattrs.Attributes.back().second);
diff --git a/api/trace/+opentelemetry/+trace/Span.m b/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);
diff --git a/api/trace/+opentelemetry/+trace/Tracer.m b/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
diff --git a/test/tlogs.m b/test/tlogs.m
@@ -75,7 +75,10 @@ function testBasic(testCase)
                 tol = seconds(4);
                 verifyLessThanOrEqual(testCase, abs(datetime(double(string(...
                     results.resourceLogs.scopeLogs.logRecords.observedTimeUnixNano))/1e9, ...
-                    "convertFrom", "posixtime", "TimeZone", "UTC") - expectedtimestamp), tol);
+                    "convertFrom", "posixtime", "TimeZone", "UTC") - expectedtimestamp), tol); 
+                % by default, Timestamp and ObservedTimestamp should be identical
+                verifyEqual(testCase, results.resourceLogs.scopeLogs.logRecords.observedTimeUnixNano, ...
+                    results.resourceLogs.scopeLogs.logRecords.timeUnixNano);
 
                 % check resource
                 resourcekeys = string({results.resourceLogs.resource.attributes.key});
@@ -282,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)
diff --git a/test/ttrace.m b/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});
 
