Skip to content

Commit f85ec60

Browse files
committed
More docs improvements
1 parent af458bf commit f85ec60

File tree

1 file changed

+6
-1
lines changed
  • opamp/opentelemetry-opamp-client/src/opentelemetry/_opamp

1 file changed

+6
-1
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
-----------------------------------
1818
1919
This package provides a bunch of classes that can be used by OpenTelemetry distributions implementors
20-
to implement remote config support via the OpAMP protocol.
20+
to implement remote config support via the `OpAMP protocol`_.
2121
2222
The client implements the following capabilities:
2323
@@ -28,6 +28,10 @@
2828
2929
These capabilities are enough to get a remote config from an opamp server, parse it, apply it and ack it.
3030
31+
While the client supports pluggable transports, only an HTTP backends using the ``requests`` library is
32+
implemented. Adding WebSocket support shouldn't be hard but it will require some rework in the OpAMPAgent
33+
class.
34+
3135
Since OpAMP APIs, config options or environment variables are not standardizes the distros are required
3236
to provide code doing so.
3337
OTel Python distros would need to provide their own message handler callback that implements the actual
@@ -82,6 +86,7 @@ def _configure(self, **kwargs):
8286
8387
API
8488
---
89+
.. _OpAMP protocol: https://opentelemetry.io/docs/specs/opamp/
8590
"""
8691

8792
from opentelemetry._opamp.agent import OpAMPAgent

0 commit comments

Comments
 (0)