Skip to content

Commit d6c1b5f

Browse files
smokesmoke
committed
feat(bullmq): initial bullmq instrumentation
1 parent f8bb30e commit d6c1b5f

File tree

9 files changed

+718
-0
lines changed

9 files changed

+718
-0
lines changed

‎instrumentation/opentelemetry-instrumentation-bullmq/LICENSE‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity granting the License.
13+
14+
"Legal Entity" shall mean the union of the acting entity and all
15+
other entities that control, are controlled by, or are under common
16+
control with that entity. For the purposes of this definition,
17+
"control" means (i) the power, direct or indirect, to cause the
18+
direction or management of such entity, whether by contract or
19+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
20+
outstanding shares, or (iii) beneficial ownership of such entity.
21+
22+
"You" (or "Your") shall mean an individual or Legal Entity
23+
exercising permissions granted by this License.
24+
25+
"Source" shall mean the preferred form for making modifications,
26+
including but not limited to software source code, documentation
27+
source, and configuration files.
28+
29+
"Object" shall mean any form resulting from mechanical
30+
transformation or translation of a Source form, including but
31+
not limited to compiled object code, generated documentation,
32+
and conversions to other media types.
33+
34+
"Work" shall mean the work of authorship, whether in Source or
35+
Object form, made available under the License, as indicated by a
36+
copyright notice that is included in or attached to the work
37+
(which shall not include communication that is conspicuously
38+
marked or otherwise designated in writing by the copyright owner
39+
as "Not a Work").
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based upon (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and derivative works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control
58+
systems, and issue tracking systems that are managed by, or on behalf
59+
of, the Licensor for the purpose of discussing and improving the Work,
60+
but excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Work".
62+
63+
2. Grant of Copyright License. Subject to the terms and conditions of
64+
this License, each Contributor hereby grants to You a perpetual,
65+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66+
copyright license to use, reproduce, modify, distribute, and prepare
67+
Derivative Works of the Work, and to permit persons to whom the Work
68+
is furnished to do so, subject to the following conditions:
69+
70+
The above copyright notice and this permission notice shall be
71+
included in all copies or substantial portions of the Work.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, trademark, patent,
102+
and attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright notice to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Support. Unless otherwise agreed to in writing,
166+
neither the Licensor nor any Contributor to this package will be liable
167+
for any support, consultation, training, or assistance of any kind with
168+
regard to the use, operation, and performance of this software nor to
169+
provide any security related support (e.g., updates to address security
170+
vulnerabilities, security patches or releases made specifically to
171+
address security vulnerabilities).
172+
173+
END OF TERMS AND CONDITIONS

‎instrumentation/opentelemetry-instrumentation-bullmq/README.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
OpenTelemetry BullMQ Instrumentation
2+
====================================
3+
4+
|pypi|
5+
6+
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-instrumentation-bullmq.svg
7+
:target: https://pypi.org/project/opentelemetry-instrumentation-bullmq/
8+
9+
This library allows tracing BullMQ job queue operations.
10+
11+
Installation
12+
------------
13+
14+
::
15+
16+
pip install opentelemetry-instrumentation-bullmq
17+
18+
Usage
19+
-----
20+
21+
* Start Redis backend
22+
23+
.. code-block:: bash
24+
25+
docker run -p 6379:6379 redis
26+
27+
* Run instrumented application
28+
29+
.. code-block:: python
30+
31+
from opentelemetry.instrumentation.bullmq import BullMQInstrumentor
32+
from bullmq import Queue, Worker
33+
34+
# Instrument BullMQ
35+
BullMQInstrumentor().instrument()
36+
37+
# Create queue and add job
38+
queue = Queue("myqueue")
39+
await queue.add("myjob", {"foo": "bar"})
40+
41+
# Create worker to process jobs
42+
async def process_job(job):
43+
print(f"Processing job {job.id}: {job.data}")
44+
return "completed"
45+
46+
worker = Worker("myqueue", process_job)
47+
await worker.run()
48+
49+
References
50+
----------
51+
52+
* `OpenTelemetry BullMQ Instrumentation <https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/bullmq/bullmq.html>`_
53+
* `OpenTelemetry Project <https://opentelemetry.io/>`_
54+
* `BullMQ Python <https://github.com/taskforcesh/bullmq/tree/master/python>`_

‎instrumentation/opentelemetry-instrumentation-bullmq/pyproject.toml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
[build-system]
2+
requires = ["hatchling"]
3+
build-backend = "hatchling.build"
4+
5+
[project]
6+
name = "opentelemetry-instrumentation-bullmq"
7+
dynamic = ["version"]
8+
description = "OpenTelemetry BullMQ Instrumentation"
9+
readme = "README.rst"
10+
license = "Apache-2.0"
11+
requires-python = ">=3.8"
12+
authors = [
13+
{ name = "OpenTelemetry Authors", email = "[email protected]" },
14+
]
15+
classifiers = [
16+
"Development Status :: 4 - Beta",
17+
"Intended Audience :: Developers",
18+
"License :: OSI Approved :: Apache Software License",
19+
"Programming Language :: Python",
20+
"Programming Language :: Python :: 3",
21+
"Programming Language :: Python :: 3.8",
22+
"Programming Language :: Python :: 3.9",
23+
"Programming Language :: Python :: 3.10",
24+
"Programming Language :: Python :: 3.11",
25+
"Programming Language :: Python :: 3.12",
26+
"Programming Language :: Python :: 3.13",
27+
]
28+
dependencies = [
29+
"opentelemetry-api ~= 1.12",
30+
"opentelemetry-instrumentation == 0.52b0.dev",
31+
"opentelemetry-semantic-conventions == 0.52b0.dev",
32+
"wrapt >= 1.0.0, < 2.0.0",
33+
]
34+
35+
[project.optional-dependencies]
36+
instruments = [
37+
"bullmq",
38+
]
39+
40+
[project.entry-points.opentelemetry_instrumentor]
41+
bullmq = "opentelemetry.instrumentation.bullmq:BullMQInstrumentor"
42+
43+
[project.urls]
44+
Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-bullmq"
45+
Repository = "https://github.com/open-telemetry/opentelemetry-python-contrib"
46+
47+
[tool.hatch.version]
48+
path = "src/opentelemetry/instrumentation/bullmq/version.py"
49+
50+
[tool.hatch.build.targets.sdist]
51+
include = [
52+
"/src",
53+
"/tests",
54+
]
55+
56+
[tool.hatch.build.targets.wheel]
57+
packages = ["src/opentelemetry"]

0 commit comments

Comments
 (0)