-
Notifications
You must be signed in to change notification settings - Fork 651
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add Jaeger exporter #174
Merged
Oberon00
merged 15 commits into
open-telemetry:master
from
kinvolk:mauricio/add_jaeger_exporter
Oct 8, 2019
Merged
add Jaeger exporter #174
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
6124eea
add Jaeger exporter
mauriciovasquezbernal 515527e
handle review #1
mauriciovasquezbernal 3bc29a2
Merge branch 'master' into mauricio/add_jaeger_exporter
mauriciovasquezbernal f32aee8
fix merge
mauriciovasquezbernal 6b93079
avoid use of deque.copy()
mauriciovasquezbernal 3d2f089
Merge branch 'master' into mauricio/add_jaeger_exporter
mauriciovasquezbernal 11cac7c
generate python files from thrift
mauriciovasquezbernal fd91817
fix tests
mauriciovasquezbernal a0e3402
add readme
mauriciovasquezbernal 93e49f1
make lint happy
mauriciovasquezbernal 3b6872a
futher reviews
mauriciovasquezbernal 88e02b4
include generated files on the repo again
mauriciovasquezbernal 6de0518
make service name mandatory
mauriciovasquezbernal b40a30f
remove disabled warning for pylint
mauriciovasquezbernal 508e166
remove type annotations
mauriciovasquezbernal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
[flake8] | ||
ignore = E501,W503,E203 | ||
exclude = .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,ext/opentelemetry-ext-jaeger/src/opentelemetry/ext/jaeger/gen/,ext/opentelemetry-ext-jaeger/build/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
OpenTelemetry Jaeger Exporter | ||
============================= | ||
|
||
Installation | ||
------------ | ||
|
||
:: | ||
|
||
pip install opentelemetry-ext-jaeger | ||
|
||
|
||
Usage | ||
----- | ||
|
||
The **OpenTelemetry Jaeger Exporter** allows to export `OpenTelemetry`_ traces to `Jaeger`_. | ||
This exporter always send traces to the configured agent using Thrift compact protocol over UDP. | ||
An optional collector can be configured, in this case Thrift binary protocol over HTTP is used. | ||
gRPC is still not supported by this implementation. | ||
|
||
|
||
.. _Jaeger: https://www.jaegertracing.io/ | ||
.. _OpenTelemetry: https://github.com/opentelemetry/opentelemetry-python/ | ||
|
||
.. code:: python | ||
|
||
from opentelemetry import trace | ||
from opentelemetry.ext import jaeger | ||
from opentelemetry.sdk.trace import Tracer | ||
from opentelemetry.sdk.trace.export import BatchExportSpanProcessor | ||
|
||
trace.set_preferred_tracer_implementation(lambda T: Tracer()) | ||
tracer = trace.tracer() | ||
|
||
# create a JaegerSpanExporter | ||
jaeger_exporter = jaeger.JaegerSpanExporter( | ||
service_name='my-helloworld-service', | ||
# configure agent | ||
agent_host_name='localhost', | ||
agent_port=6831, | ||
# optional: configure also collector | ||
# collector_host_name='localhost', | ||
# collector_port=14268, | ||
# collector_endpoint='/api/traces?format=jaeger.thrift', | ||
# username=xxxx, # optional | ||
# password=xxxx, # optional | ||
) | ||
|
||
# Create a BatchExportSpanProcessor and add the exporter to it | ||
span_processor = BatchExportSpanProcessor(jaeger_exporter) | ||
|
||
# add to the tracer | ||
tracer.add_span_processor(span_processor) | ||
|
||
with tracer.start_span('foo'): | ||
print('Hello world!') | ||
|
||
# shutdown the span processor | ||
# TODO: this has to be improved so user doesn't need to call it manually | ||
span_processor.shutdown() | ||
|
||
The `examples <./examples>`_ folder contains more elaborated examples. | ||
|
||
References | ||
---------- | ||
|
||
* `Jaeger <https://www.jaegertracing.io/>`_ | ||
* `OpenTelemetry Project <https://opentelemetry.io/>`_ |
51 changes: 51 additions & 0 deletions
51
ext/opentelemetry-ext-jaeger/examples/jaeger_exporter_example.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
import time | ||
|
||
from opentelemetry import trace | ||
from opentelemetry.ext import jaeger | ||
from opentelemetry.sdk.trace import Tracer | ||
from opentelemetry.sdk.trace.export import BatchExportSpanProcessor | ||
|
||
trace.set_preferred_tracer_implementation(lambda T: Tracer()) | ||
tracer = trace.tracer() | ||
|
||
# create a JaegerSpanExporter | ||
jaeger_exporter = jaeger.JaegerSpanExporter( | ||
service_name="my-helloworld-service", | ||
# configure agent | ||
agent_host_name="localhost", | ||
agent_port=6831, | ||
# optional: configure also collector | ||
# collector_host_name="localhost", | ||
# collector_port=14268, | ||
# collector_endpoint="/api/traces?format=jaeger.thrift", | ||
# username=xxxx, # optional | ||
# password=xxxx, # optional | ||
) | ||
|
||
# create a BatchExportSpanProcessor and add the exporter to it | ||
span_processor = BatchExportSpanProcessor(jaeger_exporter) | ||
|
||
# add to the tracer | ||
tracer.add_span_processor(span_processor) | ||
|
||
# create some spans for testing | ||
with tracer.start_span("foo") as foo: | ||
time.sleep(0.1) | ||
foo.set_attribute("my_atribbute", True) | ||
foo.add_event("event in foo", {"name": "foo1"}) | ||
with tracer.start_span("bar") as bar: | ||
time.sleep(0.2) | ||
bar.set_attribute("speed", 100.0) | ||
bar.add_link(foo.get_context()) | ||
|
||
with tracer.start_span("baz") as baz: | ||
time.sleep(0.3) | ||
baz.set_attribute("name", "mauricio") | ||
|
||
time.sleep(0.2) | ||
|
||
time.sleep(0.1) | ||
|
||
# shutdown the span processor | ||
# TODO: this has to be improved so user doesn't need to call it manually | ||
span_processor.shutdown() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Copyright 2019, 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. | ||
# | ||
[metadata] | ||
name = opentelemetry-ext-jaeger | ||
description = Jaeger Exporter for OpenTelemetry | ||
long_description = file: README.rst | ||
long_description_content_type = text/x-rst | ||
author = OpenTelemetry Authors | ||
author_email = cncf-opentelemetry-contributors@lists.cncf.io | ||
url = https://github.com/open-telemetry/opentelemetry-python/ext/opentelemetry-ext-jaeger | ||
platforms = any | ||
license = Apache-2.0 | ||
classifiers = | ||
Development Status :: 3 - Alpha | ||
Intended Audience :: Developers | ||
License :: OSI Approved :: Apache Software License | ||
Programming Language :: Python | ||
Programming Language :: Python :: 3 | ||
Programming Language :: Python :: 3.4 | ||
Programming Language :: Python :: 3.5 | ||
Programming Language :: Python :: 3.6 | ||
Programming Language :: Python :: 3.7 | ||
|
||
[options] | ||
python_requires = >=3.4 | ||
package_dir= | ||
=src | ||
packages=find_namespace: | ||
install_requires = | ||
thrift >= 0.10.0 | ||
opentelemetry-api | ||
opentelemetry-sdk | ||
|
||
[options.packages.find] | ||
where = src |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Copyright 2019, 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. | ||
import os | ||
|
||
import setuptools | ||
|
||
BASE_DIR = os.path.dirname(__file__) | ||
VERSION_FILENAME = os.path.join( | ||
BASE_DIR, "src", "opentelemetry", "ext", "jaeger", "version.py" | ||
) | ||
PACKAGE_INFO = {} | ||
with open(VERSION_FILENAME) as f: | ||
exec(f.read(), PACKAGE_INFO) | ||
|
||
setuptools.setup(version=PACKAGE_INFO["__version__"]) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI: this link is incorrect. it should be open-telemetry for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!, I think I'm contributor number one with more typos done...
Will be solved in #289.