Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Deprecate otlp_proto_grpc and otlp_proto_http in auto-instrumentation #1250

Merged
merged 16 commits into from
Oct 27, 2022
Merged

Deprecate otlp_proto_grpc and otlp_proto_http in auto-instrumentation #1250

Changes from 2 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7f6a041
Deprecate otlp_proto_grpc and otlp_proto_http in auto-instrumentation
ronyis Aug 29, 2022
da269f5
tests
ronyis Aug 29, 2022
922b349
lint
ronyis Aug 30, 2022
be7dce8
Merge branch 'main' into otlp-protocol-env-vars
ronyis Sep 7, 2022
f96e768
CR fix
ronyis Sep 11, 2022
6cbf14d
Merge branch 'otlp-protocol-env-vars' of https://github.com/epsagon/o…
ronyis Sep 11, 2022
ea4e189
Merge branch 'main' into otlp-protocol-env-vars
ronyis Sep 11, 2022
612c86d
Update opentelemetry-distro/tests/test_distro.py
ronyis Sep 11, 2022
67b07e9
lint
ronyis Sep 12, 2022
7c9b724
Updating changelog
ronyis Sep 12, 2022
626289f
Merge branch 'main' into otlp-protocol-env-vars
ronyis Sep 12, 2022
34f76ac
Merge branch 'main' into otlp-protocol-env-vars
shalevr Oct 11, 2022
32c3b31
Merge branch 'main' into otlp-protocol-env-vars
ronyis Oct 18, 2022
1b89f29
Update CHANGELOG.md
ronyis Oct 18, 2022
2aab7ff
Merge branch 'main' into otlp-protocol-env-vars
ronyis Oct 27, 2022
448dff7
Fixing CHANGELOG.md
ronyis Oct 27, 2022
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
4 changes: 2 additions & 2 deletions opentelemetry-distro/src/opentelemetry/distro/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -34,5 +34,5 @@ class OpenTelemetryDistro(BaseDistro):

# pylint: disable=no-self-use
def _configure(self, **kwargs):
os.environ.setdefault(OTEL_TRACES_EXPORTER, "otlp_proto_grpc")
os.environ.setdefault(OTEL_METRICS_EXPORTER, "otlp_proto_grpc")
os.environ.setdefault(OTEL_TRACES_EXPORTER, "otlp")
os.environ.setdefault(OTEL_METRICS_EXPORTER, "otlp")
11 changes: 9 additions & 2 deletions opentelemetry-distro/tests/test_distro.py
View file
Original file line number Diff line number Diff line change
@@ -19,7 +19,10 @@
from pkg_resources import DistributionNotFound, require

from opentelemetry.distro import OpenTelemetryDistro
from opentelemetry.environment_variables import OTEL_TRACES_EXPORTER
from opentelemetry.environment_variables import (
OTEL_TRACES_EXPORTER,
OTEL_METRICS_EXPORTER,
)


class TestDistribution(TestCase):
@@ -32,7 +35,11 @@ def test_package_available(self):
def test_default_configuration(self):
distro = OpenTelemetryDistro()
self.assertIsNone(os.environ.get(OTEL_TRACES_EXPORTER))
self.assertIsNone(os.environ.get(OTEL_METRICS_EXPORTER))
distro.configure()
self.assertEqual(
"otlp_proto_grpc", os.environ.get(OTEL_TRACES_EXPORTER)
"otlp", os.environ.get(OTEL_TRACES_EXPORTER)
)
self.assertEqual(
"otlp", os.environ.get(OTEL_METRICS_EXPORTER)
)
12 changes: 7 additions & 5 deletions opentelemetry-instrumentation/README.rst
View file
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ This package provides a couple of commands that help automatically instruments a
For more info about ``opentelemetry-distro`` check `here <https://opentelemetry-python.readthedocs.io/en/latest/examples/distro/README.html>`__
::

pip install opentelemetry-distro[otlp]
pip install opentelemetry-distro
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is how it is installed (also specified in https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-distro#installation)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's different. The auto instrumentation requires it this way otherwise without any exporter users won't see any telemetry.



opentelemetry-bootstrap
@@ -57,6 +57,7 @@ The command supports the following configuration options as CLI arguments and en


* ``--traces_exporter`` or ``OTEL_TRACES_EXPORTER``
* ``--metrics_exporter`` or ``OTEL_METRICS_EXPORTER``

Used to specify which trace exporter to use. Can be set to one or more of the well-known exporter
names (see below).
@@ -71,13 +72,14 @@ Well known trace exporter names:
- jaeger_proto
- jaeger_thrift
- opencensus
- otlp
- otlp_proto_grpc
- otlp_proto_http
- zipkin_json
- zipkin_proto
- otlp
- otlp_proto_grpc (`deprecated`)
- otlp_proto_http (`deprecated`)
Comment on lines +78 to +79
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should not recommend using this, as the defined way in OTel to configure the protocol is with the other env vars, and to avoid conflicts.

In future versions, we may also remove these options (though it's a breaking change).


``otlp`` is an alias for ``otlp_proto_grpc``.
Note: The default transport protocol for ``otlp`` is gRPC.
HTTP is currently supported for traces only, and should be set using ``OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=http/protobuf``
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest not using the more general way of OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf, since it's still not supported for metrics & logs.


* ``--id-generator`` or ``OTEL_PYTHON_ID_GENERATOR``