Fix docs build

Author: xrmx

docs-requirements.txt

@@ -44,6 +44,11 @@ sqlalchemy>=1.0
 tornado>=5.1.1
 tortoise-orm>=0.17.0
 
+# required by opamp
+uuid_utils
+protobuf>=5.0,< 7.0
+
 # indirect dependency pins
 markupsafe==2.0.1
 itsdangerous==2.0.1
+

docs/opamp/client.rst

@@ -2,6 +2,6 @@ OpenTelemetry Python - OpAMP Client
 ===================================
 
 .. automodule:: opentelemetry._opamp
-    :members: agent, client
+    :members:
     :undoc-members:
     :show-inheritance:

opamp/opentelemetry-opamp-client/src/opentelemetry/_opamp/__init__.py

@@ -0,0 +1,90 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+OpenTelemetry Python - OpAMP client
+-----------------------------------
+
+This package provides a bunch of classes that can be used by OpenTelemetry distributions implementors
+to implement remote config support via the OpAMP protocol.
+
+The client implements the following capabilities:
+
+* ReportsStatus
+* ReportsHeartbeat
+* AcceptsRemoteConfig
+* ReportsRemoteConfig
+
+These capabilities are enough to get a remote config from an opamp server, parse it, apply it and ack it.
+
+Since OpAMP APIs, config options or environment variables are not standardizes the distros are required
+to provide code doing so.
+OTel Python distros would need to provide their own message handler callback that implements the actual
+change of whatever configuration their backends sends.
+
+Please note that the API is not finalized yet and so the name is called ``_opamp`` with the underscore.
+
+Usage
+-----
+
+.. code-block:: python
+
+    import os
+
+    from opentelemetry._opamp import messages
+    from opentelemetry._opamp.agent import OpAMPAgent
+    from opentelemetry._opamp.client import OpAMPClient
+    from opentelemetry._opamp.proto import opamp_pb2 as opamp_pb2
+    from opentelemetry.sdk._configuration import _OTelSDKConfigurator
+    from opentelemetry.sdk.resources import OTELResourceDetector
+
+
+    def opamp_handler(agent: OpAMPAgent, client: OpAMPClient, message: opamp_pb2.ServerToAgent):
+        for config_filename, config in messages._decode_remote_config(message.remote_config):
+            print("do something")
+
+
+    class MyOpenTelemetryConfigurator(_OTelSDKConfigurator):
+        def _configure(self, **kwargs):
+            super()._configure(**kwargs)
+
+            enable_opamp = False
+            endpoint = os.environ.get("OTEL_PYTHON_OPAMP_ENDPOINT")
+            if endpoint:
+                # this is not great but we don't have the calculated resource attributes around
+                # see https://github.com/open-telemetry/opentelemetry-python/pull/4646 for creating
+                # an entry point distros can implement
+                resource = OTELResourceDetector().detect()
+                agent_identifying_attributes = {
+                    "service.name": resource.attributes.get("service.name"),
+                }
+                opamp_client = OpAMPClient(
+                    endpoint=endpoint,
+                    agent_identifying_attributes=agent_identifying_attributes,
+                )
+                opamp_agent = OpAMPAgent(
+                    interval=30,
+                    message_handler=opamp_handler,
+                    client=opamp_client,
+                )
+                opamp_agent.start()
+
+API
+---
+"""
+
+from opentelemetry._opamp.agent import OpAMPAgent
+from opentelemetry._opamp.client import OpAMPClient
+
+__all__ = ["OpAMPAgent", "OpAMPClient"]

opamp/opentelemetry-opamp-client/src/opentelemetry/_opamp/agent.py

@@ -27,78 +27,6 @@
 logger = logging.getLogger(__name__)
 
 
-"""
-OpenTelemetry Python - OpAMP client
------------------------------------
-
-This package provides a bunch of classes that can be used by OpenTelemetry distributions implementors
-to implement remote config support via the OpAMP protocol.
-
-The client implements the following capabilities:
-- ReportsStatus
-- ReportsHeartbeat
-- AcceptsRemoteConfig
-- ReportsRemoteConfig
-
-These capabilities are enough to get a remote config from an opamp server, parse it, apply it and ack it.
-
-Since OpAMP APIs, config options or environment variables are not standardizes the distros are required
-to provide code doing so.
-OTel Python distros would need to provide their own message handler callback that implements the actual
-change of whatever configuration their backends sends.
-
-Please note that the API is not finalized yet and so the name is called ``_opamp`` with the underscore.
-
-Usage
------
-
-.. code-block:: python
-
-    import os
-
-    from opentelemetry._opamp import messages
-    from opentelemetry._opamp.agent import OpAMPAgent
-    from opentelemetry._opamp.client import OpAMPClient
-    from opentelemetry._opamp.proto import opamp_pb2 as opamp_pb2
-    from opentelemetry.sdk._configuration import _OTelSDKConfigurator
-    from opentelemetry.sdk.resources import OTELResourceDetector
-
-
-    def opamp_handler(agent: OpAMPAgent, client: OpAMPClient, message: opamp_pb2.ServerToAgent):
-        for config_filename, config in messages._decode_remote_config(message.remote_config):
-            print("do something")
-
-
-    class MyOpenTelemetryConfigurator(_OTelSDKConfigurator):
-        def _configure(self, **kwargs):
-            super()._configure(**kwargs)
-
-            enable_opamp = False
-            endpoint = os.environ.get("OTEL_PYTHON_OPAMP_ENDPOINT")
-            if endpoint:
-                # this is not great but we don't have the calculated resource attributes around
-                # see https://github.com/open-telemetry/opentelemetry-python/pull/4646 for creating
-                # an entry point distros can implement
-                resource = OTELResourceDetector().detect()
-                agent_identifying_attributes = {
-                    "service.name": resource.attributes.get("service.name"),
-                }
-                opamp_client = OpAMPClient(
-                    endpoint=endpoint,
-                    agent_identifying_attributes=agent_identifying_attributes,
-                )
-                opamp_agent = OpAMPAgent(
-                    interval=30,
-                    message_handler=opamp_handler,
-                    client=opamp_client,
-                )
-                opamp_agent.start()
-
-API
----
-"""
-
-
 class _Job:
     """
     Represents a single request job, with retry/backoff metadata.