help text for exporters

Author: duncanpo

exporters/otlp/+opentelemetry/+exporters/+otlp/OtlpGrpcSpanExporter.m

@@ -6,16 +6,38 @@
 % Copyright 2023 The MathWorks, Inc.
 
     properties (SetAccess=immutable)
-        Endpoint (1,1) string
-        UseCredentials  (1,1) logical
-        CertificatePath (1,1) string
-        CertificateString (1,1) string
-        Timeout (1,1) duration
-        HttpHeaders (1,1) dictionary
+        Endpoint (1,1) string               % Export destination
+        UseCredentials  (1,1) logical       % Whether to use SSL credentials
+        CertificatePath (1,1) string        % Path to .pem file for SSL encryption
+        CertificateString (1,1) string      % In-memory string representation of .pem file for SSL encryption
+        Timeout (1,1) duration              % Maximum time above which exports will abort
+        HttpHeaders (1,1) dictionary        % Additional HTTP headers
     end
 
     methods
         function obj = OtlpGrpcSpanExporter(optionnames, optionvalues)
+            % OtlpGrpcSpanExporter exports spans in OpenTelemetry Protocol format via gRPC.
+            %    EXP = OPENTELEMETRY.EXPORTERS.OTLP.OTLPGRPCSPANEXPORTER
+            %    creates an exporter that uses default configurations.
+            %
+            %    EXP =
+            %    OPENTELEMETRY.EXPORTERS.OTLP.OTLPGRPCSPANEXPORTER(PARAM1,
+            %    VALUE1, PARAM2, VALUE2, ...) specifies optional parameter 
+            %    name/value pairs. Parameters are:
+            %       "Endpoint"          - Endpoint to export to
+            %       "UseCredentials"    - Whether to use SSL credentials.
+            %                             Default is false. If true, use
+            %                             .pem file specified in
+            %                             "CertificatePath" or
+            %                             "CertificateString".
+            %       "CertificatePath"   - Path to .pem file for SSL encryption
+            %       "CertificateString" - .pem file specified in memory as
+            %                             a string
+            %       "Timeout"           - Maximum time above which exports 
+            %                             will abort
+            %       "HTTPHeaders"       - Additional HTTP Headers
+            %
+            %    See also OPENTELEMETRY.EXPORTERS.OTLP.OTLPHTTPSPANEXPORTER
             arguments (Repeating)
                 optionnames (1,:) {mustBeTextScalar}
                 optionvalues

exporters/otlp/+opentelemetry/+exporters/+otlp/OtlpHttpSpanExporter.m

@@ -6,16 +6,38 @@
 % Copyright 2023 The MathWorks, Inc.
 
     properties (SetAccess=immutable)
-        Endpoint (1,1) string
-        Format (1,1) string
-        JsonBytesMapping (1,1) string
-        UseJsonName (1,1) logical
-        Timeout (1,1) duration
-        HttpHeaders (1,1) dictionary
+        Endpoint (1,1) string           % Export destination
+        Format (1,1) string             % Data format, JSON or binary
+        JsonBytesMapping (1,1) string   % What to convert JSON bytes to
+        UseJsonName (1,1) logical       % Whether to use JSON name of protobuf field to set the key of JSON 
+        Timeout (1,1) duration          % Maximum time above which exports will abort
+        HttpHeaders (1,1) dictionary    % Additional HTTP headers
     end
 
     methods
         function obj = OtlpHttpSpanExporter(optionnames, optionvalues)
+            % OtlpHttpSpanExporter exports spans in OpenTelemetry Protocol format via HTTP.
+            %    EXP = OPENTELEMETRY.EXPORTERS.OTLP.OTLPHTTPSPANEXPORTER
+            %    creates an exporter that uses default configurations.
+            %
+            %    EXP =
+            %    OPENTELEMETRY.EXPORTERS.OTLP.OTLPHTTPSPANEXPORTER(PARAM1,
+            %    VALUE1, PARAM2, VALUE2, ...) specifies optional parameter 
+            %    name/value pairs. Parameters are:
+            %       "Endpoint"          - Endpoint to export to
+            %       "Format"            - Data format: "JSON" (default) or "binary"
+            %       "JsonBytesMapping"  - What to convert JSON bytes to. Supported
+            %                             values are "hex", "hexId" (default), and
+            %                             "base64". Default "hexId"
+            %                             converts to base 64 except for IDs
+            %                             which are converted to hexadecimals.
+            %       "UseJsonName"       - Whether to use JSON name of protobuf 
+            %                             field to set the key of JSON
+            %       "Timeout"           - Maximum time above which exports 
+            %                             will abort
+            %       "HTTPHeaders"       - Additional HTTP Headers
+            %
+            %    See also OPENTELEMETRY.EXPORTERS.OTLP.OTLPGRPCSPANEXPORTER
             arguments (Repeating)
                 optionnames (1,:) {mustBeTextScalar}
                 optionvalues