Adding docs

Author: ocelotl

docs/conf.py

@@ -21,6 +21,16 @@
 # DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.
 from django.conf import settings
 
+from opentelemetry.sdk.metrics.instrument import (
+    _Instrument,
+    _Synchronous,
+    _Asynchronous,
+    _Adding,
+    _Grouping,
+    _Monotonic,
+    _NonMonotonic,
+)
+
 settings.configure()
 
 exp = "../exporter"
@@ -177,3 +187,21 @@
     "scm_raw_web": (scm_raw_web + "/%s", "scm_raw_web"),
     "scm_web": (scm_web + "/%s", "scm_web"),
 }
+
+
+def skip_private_sdk_instrument_classes(app, what, name, obj, skip, options):
+
+    return obj in [
+        _Instrument,
+        _Synchronous,
+        _Asynchronous,
+        _Adding,
+        _Grouping,
+        _Monotonic,
+        _NonMonotonic,
+    ] or None
+
+
+def setup(app):
+    # app.connect("autodoc-skip-member", skip_private_sdk_instrument_classes)
+    pass

docs/sdk/metrics.instrument.rst

@@ -5,3 +5,4 @@ opentelemetry.sdk.metrics.instrument
     :members:
     :undoc-members:
     :show-inheritance:
+    :private-members:

opentelemetry-sdk/src/opentelemetry/sdk/metrics/aggregator.py

@@ -21,9 +21,15 @@
 
 
 class Aggregator(ABC):
+    """Aggregator.
+
+    sdfsd
+    """
+
     @classmethod
     @abstractmethod
     def _get_value_name(cls):
+        """_get_value_name."""
         pass
 
     @abstractmethod
@@ -40,6 +46,10 @@ def aggregate(self, value):
 
     @abstractmethod
     def _aggregate(self, new_value):
+        """_aggregate.
+
+        :param new_value:
+        """
         pass
 
 
@@ -63,7 +73,13 @@ def _get_value_name(cls):
     def _get_initial_value(self):
         return inf
 
-    def _aggregate(self, value):
+    def _aggregate(self, value: int) -> int:
+        """_aggregate.
+
+        :param value:
+        :type value: int
+        :rtype: int
+        """
 
         return min(self._value, value)
 
@@ -169,9 +185,6 @@ def _aggregate(self, value):
 
 
 class HistogramAggregator(Aggregator):
-    """
-    The rightmost bin is [], the other ones are [[.
-    """
 
     def __init__(self, buckets, *args, **kwargs):
 

opentelemetry-sdk/src/opentelemetry/sdk/metrics/export.py

@@ -97,10 +97,6 @@ def shutdown(self):
 
 class MemoryExporter(Exporter):
     """Implementation of `Exporter` that stores metrics in memory.
-
-    This class can be used for testing purposes. It stores exported metrics
-    in a list in memory that can be retrieved using the
-    :func:`.exported_metrics` property.
     """
 
     def __init__(self):