Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable Cleanup class to work for SDK objects #51

Merged
merged 1 commit into from
Nov 8, 2023
Merged

enable Cleanup class to work for SDK objects #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,7 @@ set(BAGGAGE_API_MATLAB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/api/baggage/+opentele
set(COMMON_API_MATLAB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/api/common/+opentelemetry)
set(TRACE_SDK_MATLAB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/sdk/trace/+opentelemetry)
set(METRICS_SDK_MATLAB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/sdk/metrics/+opentelemetry)
set(COMMON_SDK_MATLAB_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/sdk/common/+opentelemetry)
set(DEFAULT_EXPORTER_MATLAB_SOURCES
${CMAKE_CURRENT_SOURCE_DIR}/exporters/otlp/+opentelemetry/+exporters/+otlp/defaultSpanExporter.m
${CMAKE_CURRENT_SOURCE_DIR}/exporters/otlp/+opentelemetry/+exporters/+otlp/defaultMetricExporter.m)
Expand All @@ -417,6 +418,7 @@ install(DIRECTORY ${BAGGAGE_API_MATLAB_SOURCES} DESTINATION .)
install(DIRECTORY ${COMMON_API_MATLAB_SOURCES} DESTINATION .)
install(DIRECTORY ${TRACE_SDK_MATLAB_SOURCES} DESTINATION .)
install(DIRECTORY ${METRICS_SDK_MATLAB_SOURCES} DESTINATION .)
install(DIRECTORY ${COMMON_SDK_MATLAB_SOURCES} DESTINATION .)
install(FILES ${DEFAULT_EXPORTER_MATLAB_SOURCES} DESTINATION ${OTLP_EXPORTERS_DIR})
if(WITH_OTLP_HTTP)
install(FILES ${OTLP_HTTP_EXPORTER_MATLAB_SOURCES} DESTINATION ${OTLP_EXPORTERS_DIR})
Expand Down
4 changes: 2 additions & 2 deletions api/metrics/+opentelemetry/+metrics/MeterProvider.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

% Copyright 2023 The MathWorks, Inc.

properties (Access={?opentelemetry.sdk.metrics.MeterProvider, ?opentelemetry.sdk.metrics.Cleanup})
properties (Access={?opentelemetry.sdk.metrics.MeterProvider, ?opentelemetry.sdk.common.Cleanup})
Proxy % Proxy object to interface C++ code
end

Expand Down Expand Up @@ -60,7 +60,7 @@ function setMeterProvider(obj)
end
end

methods(Access=?opentelemetry.sdk.metrics.Cleanup)
methods(Access=?opentelemetry.sdk.common.Cleanup)
function postShutdown(obj)
% POSTSHUTDOWN Handle post-shutdown tasks
obj.Proxy.postShutdown();
Expand Down
4 changes: 2 additions & 2 deletions api/trace/+opentelemetry/+trace/TracerProvider.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
% Copyright 2023 The MathWorks, Inc.

properties (Access={?opentelemetry.sdk.trace.TracerProvider, ...
?opentelemetry.sdk.trace.Cleanup})
?opentelemetry.sdk.common.Cleanup})
Proxy % Proxy object to interface C++ code
end

Expand Down Expand Up @@ -61,7 +61,7 @@ function setTracerProvider(obj)
end
end

methods(Access=?opentelemetry.sdk.trace.Cleanup)
methods(Access=?opentelemetry.sdk.common.Cleanup)
function postShutdown(obj)
% POSTSHUTDOWN Handle post-shutdown tasks
obj.Proxy.postShutdown();
Expand Down
95 changes: 95 additions & 0 deletions sdk/common/+opentelemetry/+sdk/+common/Cleanup.m
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
classdef Cleanup
% Clean up methods for TracerProvider and MeterProvider

% Copyright 2023 The MathWorks, Inc.

methods (Static)
function success = shutdown(p)
% SHUTDOWN Shutdown
% SUCCESS = SHUTDOWN(P) shuts down all processors/readers
% associated with P. P may be a tracer provider or a meter
% provider. Returns a logical that indicates whether
% shutdown was successful.
%
% See also FORCEFLUSH

success = true;
% return false if input is not the right type
issdk = isa(p, "opentelemetry.sdk.trace.TracerProvider") || ...
isa(p, "opentelemetry.sdk.metrics.MeterProvider");
if issdk
psdk = p;
elseif isa(p, "opentelemetry.trace.TracerProvider")
% convert to TracerProvider class in sdk
try
psdk = opentelemetry.sdk.trace.TracerProvider(p.Proxy);
catch
success = false;
end
elseif isa(p, "opentelemetry.metrics.MeterProvider")
% convert to MeterProvider class in sdk
try
psdk = opentelemetry.sdk.metrics.MeterProvider(p.Proxy);
catch
success = false;
end
else
success = false;
end

if success % still not yet set to false, proceed to shutdown
success = psdk.shutdown;
if ~issdk
% API classes need extra work to swap to a no-op object
postShutdown(p);
end
end
end

function success = forceFlush(p, timeout)
% FORCEFLUSH Force flush
% SUCCESS = FORCEFLUSH(P) immediately exports all spans
% or metrics that have not yet been exported. Returns a
% logical that indicates whether force flush was successful.
%
% SUCCESS = FORCEFLUSH(P, TIMEOUT) specifies a TIMEOUT
% duration. Force flush must be completed within this time,
% or else it will fail.
%
% See also SHUTDOWN

success = true;

% return false if input is not the right type
if isa(p, "opentelemetry.sdk.trace.TracerProvider") || ...
isa(p, "opentelemetry.sdk.metrics.MeterProvider")
psdk = p;
elseif isa(p, "opentelemetry.trace.TracerProvider")
% convert to TracerProvider class in sdk
try
psdk = opentelemetry.sdk.trace.TracerProvider(p.Proxy);
catch
success = false;
end
elseif isa(p, "opentelemetry.metrics.MeterProvider")
% convert to MeterProvider class in sdk
try
psdk = opentelemetry.sdk.metrics.MeterProvider(p.Proxy);
catch
success = false;
end
else
success = false;
end

if success % still not yet set to false, proceed to force flush
if nargin < 2 || ~isa(timeout, "duration")
success = psdk.forceFlush;
else
success = psdk.forceFlush(timeout);
end
end
end
end

end
63 changes: 0 additions & 63 deletions sdk/metrics/+opentelemetry/+sdk/+metrics/Cleanup.m
View file
Open in desktop

This file was deleted.

63 changes: 0 additions & 63 deletions sdk/trace/+opentelemetry/+sdk/+trace/Cleanup.m
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion test/performance/traceTest.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ function setup(testCase)
function teardown(testCase)
% Flush all spans that have not yet been exported
tp = opentelemetry.trace.Provider.getTracerProvider();
opentelemetry.sdk.trace.Cleanup.forceFlush(tp);
opentelemetry.sdk.common.Cleanup.forceFlush(tp);

commonTeardown(testCase);
end
Expand Down
80 changes: 80 additions & 0 deletions test/tmetrics_sdk.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,85 @@ function testCustomResource(testCase)
end
end

function testShutdown(testCase)
% testShutdown: shutdown method should stop exporting
% of metrics
commonSetup(testCase)

exporter = opentelemetry.exporters.otlp.OtlpHttpMetricExporter();
reader = opentelemetry.sdk.metrics.PeriodicExportingMetricReader(exporter, ...
"Interval", seconds(2), "Timeout", seconds(1));
mp = opentelemetry.sdk.metrics.MeterProvider(reader);

% shutdown the meter provider
verifyTrue(testCase, shutdown(mp));

% create an instrument and add some values
m = getMeter(mp, "foo");
c = createCounter(m, "bar");
c.add(5);

% wait a little and then gather results, verify no metrics are
% generated
pause(2.5);
clear mp;
results = readJsonResults(testCase);
verifyEmpty(testCase, results);
end

function testCleanupSdk(testCase)
% testCleanupSdk: shutdown an SDK meter provider through the Cleanup class
commonSetup(testCase)

% Shut down an SDK meter provider instance
exporter = opentelemetry.exporters.otlp.OtlpHttpMetricExporter();
reader = opentelemetry.sdk.metrics.PeriodicExportingMetricReader(exporter, ...
"Interval", seconds(2), "Timeout", seconds(1));
mp = opentelemetry.sdk.metrics.MeterProvider(reader);

% shutdown the meter provider through the Cleanup class
verifyTrue(testCase, opentelemetry.sdk.common.Cleanup.shutdown(mp));

% create an instrument and add some values
m = getMeter(mp, "foo");
c = createCounter(m, "bar");
c.add(5);

% wait a little and then gather results, verify no metrics are
% generated
pause(2.5);
clear mp;
results = readJsonResults(testCase);
verifyEmpty(testCase, results);
end

function testCleanupApi(testCase)
% testCleanupApi: shutdown an API meter provider through the Cleanup class
commonSetup(testCase)

% Shut down an API meter provider instance
exporter = opentelemetry.exporters.otlp.OtlpHttpMetricExporter();
reader = opentelemetry.sdk.metrics.PeriodicExportingMetricReader(exporter, ...
"Interval", seconds(2), "Timeout", seconds(1));
mp = opentelemetry.sdk.metrics.MeterProvider(reader);
setMeterProvider(mp);
clear("mp");
mp_api = opentelemetry.metrics.Provider.getMeterProvider();

% shutdown the API meter provider through the Cleanup class
verifyTrue(testCase, opentelemetry.sdk.common.Cleanup.shutdown(mp_api));

% create an instrument and add some values
m = getMeter(mp_api, "foo");
c = createCounter(m, "bar");
c.add(5);

% wait a little and then gather results, verify no metrics are
% generated
pause(2.5);
clear("mp_api");
results = readJsonResults(testCase);
verifyEmpty(testCase, results);
end
end
end