Skip to content

Commit ff4f341

Browse files
gugahoaclaude
gugahoa
and
claude
committed
Add baggage span processor
This adds a new span processor that takes attributes from OpenTelemetry Baggage and inserts them into spans when they start. Features: - Automatically adds all baggage entries as span attributes - Optional prefix configuration for baggage attributes - Optional filter to only include baggage with specific metadata - Comprehensive test suite The processor is configured in the OpenTelemetry processors list and must be placed before any exporting processor (e.g., batch processor). 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent adf9c5d commit ff4f341

File tree

9 files changed

+500
-0
lines changed

9 files changed

+500
-0
lines changed

‎processors/opentelemetry_baggage_processor/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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 authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
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, patent, trademark, and
102+
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 statement 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 Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎processors/opentelemetry_baggage_processor/README.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# opentelemetry_baggage_processor
2+
3+
A Span Processor that takes attributes from the Baggage and insert into the Span.
4+
5+
[![EEF Observability WG project](https://img.shields.io/badge/EEF-Observability-black)](https://github.com/erlef/eef-observability-wg)
6+
[![Hex.pm](https://img.shields.io/hexpm/v/opentelemetry_baggage_processor)](https://hex.pm/packages/opentelemetry_baggage_processor)
7+
8+
## Installation
9+
10+
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
11+
by adding `opentelemetry_baggage_processor` to your list of dependencies in `mix.exs`:
12+
13+
```elixir
14+
def deps do
15+
[
16+
{:opentelemetry_baggage_processor, "~> 0.1.0"}
17+
]
18+
end
19+
```
20+
21+
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
22+
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
23+
be found at [https://hexdocs.pm/opentelemetry_baggage_processor](https://hexdocs.pm/opentelemetry_baggage_processor).
24+
25+
## Usage
26+
27+
<!-- MDOC -->
28+
29+
`opentelemetry_baggage_processor` provides a [Span Processor](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#span-processor)
30+
that takes attributes from the [Baggage](https://hexdocs.pm/opentelemetry_api/otel_baggage.html)
31+
and insert into the Span, once it starts.
32+
33+
A Span Processor is not an application, to use it you must update your
34+
configuration:
35+
36+
```elixir
37+
# config/config.exs
38+
39+
config :opentelemetry, processors,
40+
otel_baggage_processor: %{}},
41+
otel_batch_processor: %{
42+
exporter: {:opentelemetry_exporter, %{}}
43+
}
44+
```
45+
46+
The processor configuration is order-dependent, so `otel_baggage_processor`
47+
configuration must come before the processor used for exporting – in this case,
48+
`otel_batch_processor`.
49+
50+
Now every new span should have what's inside your baggage as attribute.
51+
52+
### Options
53+
54+
* `:prefix` - adds a prefix for all baggage attributes.
55+
* `:filter` - only add attributes if the baggage metadata has the configured key.
56+
The key must be a binary.
57+
58+
### Limitations
59+
60+
Baggage will follow the Context. So any limitation to Context Propagation applies
61+
to Baggage Propagation, and thus to what attributes are going to be added to your
62+
Span.
63+
64+
We can only apply attributes on Span's start, since that's when we can modify
65+
them. There's a [BeforeEnd callback proposal](https://github.com/open-telemetry/opentelemetry-specification/issues/1089)
66+
which would allow us to add the Baggage's attribute on Span's end too, but that
67+
remains as something to be revisited in the future.
68+
69+
<!-- MDOC -->

‎processors/opentelemetry_baggage_processor/docs.config‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{source_url, <<"https://github.com/open-telemetry/opentelemetry-erlang-contrib">>}.
2+
{extras, [<<"README.md">>]}.
3+
{main, <<"readme">>}.
4+
{proglang, erlang}.

‎processors/opentelemetry_baggage_processor/docs.sh‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
#!/bin/bash
2+
set -e
3+
4+
# Setup:
5+
#
6+
# # 1. install OTP 24+
7+
# # 2. install ExDoc:
8+
# $ mix escript.install github elixir-lang/ex_doc
9+
10+
rebar3 compile
11+
rebar3 edoc
12+
13+
ex_doc "opentelemetry_baggage_processor" 0.0.1 "_build/default/lib/opentelemetry_baggage_processor/ebin" \
14+
--source-ref v0.0.1 \
15+
--config docs.config $@ \
16+
--output "doc"

‎processors/opentelemetry_baggage_processor/rebar.config‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{erl_opts, [debug_info]}.
2+
{deps, [
3+
{opentelemetry_api, "~> 1.2"}
4+
]}.
5+
6+
{project_plugins, [covertool,
7+
rebar3_fmt,
8+
rebar3_hex,
9+
rebar3_hank]}.
10+
11+
{profiles,
12+
[{docs, [{deps, [edown]}]},
13+
{github, [{plugins, [{rebar3_ex_doc, "0.2.9"}]},
14+
{ex_doc, [{source_url, <<"https://github.com/open-telemetry/opentelemetry-erlang-contrib">>},
15+
{subpackages, true}]}]},
16+
{test, [{erl_opts, [nowarn_export_all]},
17+
{deps, [
18+
{opentelemetry, "~> 1.3"}
19+
]},
20+
{paths, ["src", "test/support"]},
21+
{ct_opts, [{ct_hooks, [cth_surefire]}]}]}]}.

‎processors/opentelemetry_baggage_processor/rebar.lock‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{"1.2.0",
2+
[{<<"opentelemetry">>,{pkg,<<"opentelemetry">>,<<"1.0.4">>},0},
3+
{<<"opentelemetry_api">>,{pkg,<<"opentelemetry_api">>,<<"1.0.3">>},0}]}.
4+
[
5+
{pkg_hash,[
6+
{<<"opentelemetry">>, <<"A7DAF00A248715EE72C12BA1CBAD878837E8DCA6E9BEA12A2381A1F27DF9EBB2">>},
7+
{<<"opentelemetry_api">>, <<"77F9644C42340CD8B18C728CDE4822ED55AE136F0D07761B78E8C54DA46AF93A">>}]},
8+
{pkg_hash_ext,[
9+
{<<"opentelemetry">>, <<"D75C3931884817679CA63C21395715427457691F5C9BE06D75B71D74ADC9D0B4">>},
10+
{<<"opentelemetry_api">>, <<"4293E06BD369BC004E6FAD5EDBB56456D891F14BD3F9F1772B18F1923E0678EA">>}]}
11+
].

‎processors/opentelemetry_baggage_processor/src/opentelemetry_baggage_processor.app.src‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{application, opentelemetry_baggage_processor,
2+
[{description, "A Span Processor that takes attributes from the Baggage and insert into the Span"},
3+
{vsn, git},
4+
{registered, []},
5+
{applications,
6+
[kernel,
7+
stdlib,
8+
opentelemetry
9+
]},
10+
{env,[]},
11+
{modules, []},
12+
13+
{licenses, ["Apache 2.0"]},
14+
{links, [{"GitHub", "https://github.com/open-telemetry/opentelemetry-erlang-contrib/tree/main/processors/opentelemetry_baggage_processor"}]}
15+
]}.

0 commit comments

Comments
 (0)