Skip to content

Commit 5f0b11e

Browse files
yordisyordis
authored
feat(opentelemetry_grpc): add initial setup for opentelemetry_grpc (#554)
Signed-off-by: Yordis Prieto <[email protected]>
1 parent 2c3c905 commit 5f0b11e

File tree

21 files changed

+2063
-0
lines changed

21 files changed

+2063
-0
lines changed

‎instrumentation/opentelemetry_grpc/.formatter.exs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Used by "mix format"
2+
[
3+
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
4+
]

‎instrumentation/opentelemetry_grpc/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
cover
2+
deps
3+
_build
4+

‎instrumentation/opentelemetry_grpc/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

‎instrumentation/opentelemetry_grpc/LICENSE‎

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

‎instrumentation/opentelemetry_grpc/README.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# OpentelemetryGrpc
2+
3+
[![EEF Observability WG project](https://img.shields.io/badge/EEF-Observability-black)](https://github.com/erlef/eef-observability-wg)
4+
[![Hex.pm](https://img.shields.io/hexpm/v/opentelemetry_grpc)](https://hex.pm/packages/opentelemetry_grpc)
5+
6+
OpenTelemetry instrumentation for gRPC clients and servers in Elixir, enabling distributed tracing, error tracking, and context propagation across services.
7+
8+
This library provides comprehensive tracing for gRPC applications, supporting both client and server instrumentation with proper context propagation according to OpenTelemetry semantic conventions.
9+
10+
## Features
11+
12+
- **Client Instrumentation**: Automatic tracing of outgoing gRPC requests
13+
- **Server Instrumentation**: Automatic tracing of incoming gRPC requests
14+
- **Context Propagation**: Proper trace context propagation between services
15+
- **Error Handling**: Comprehensive error tracking and status reporting using gRPC status codes
16+
- **Semantic Conventions**: Follows OpenTelemetry semantic conventions for RPC
17+
18+
## Installation
19+
20+
Add `opentelemetry_grpc` to your list of dependencies in `mix.exs`:
21+
22+
```elixir
23+
def deps do
24+
[
25+
{:opentelemetry_grpc, "~> 1.0"}
26+
]
27+
end
28+
```
29+
30+
## Usage
31+
32+
### Basic Setup
33+
34+
For most applications, you can set up both client and server instrumentation:
35+
36+
```elixir
37+
# In your application startup (e.g., Application.start/2)
38+
OpentelemetryGrpc.setup()
39+
```
40+
41+
### Client Instrumentation
42+
43+
To instrument only gRPC client calls:
44+
45+
```elixir
46+
OpentelemetryGrpc.Client.setup()
47+
```
48+
49+
For context propagation in client requests, add the interceptor to your gRPC channel. The OpenTelemetry interceptor should typically be the first in the list to ensure proper context propagation:
50+
51+
```elixir
52+
{:ok, channel} = GRPC.Stub.connect("localhost:50051",
53+
interceptors: [OpentelemetryGrpc.ContextPropagatorInterceptor])
54+
55+
# Use the channel for your gRPC calls
56+
MyService.Stub.my_method(channel, request)
57+
```
58+
59+
### Server Instrumentation
60+
61+
To instrument only gRPC server requests:
62+
63+
```elixir
64+
OpentelemetryGrpc.Server.setup()
65+
```
66+
67+
By default, server instrumentation includes context propagation from incoming request headers. To control span relationships:
68+
69+
```elixir
70+
# Create child spans (default) - spans should be part of the same trace
71+
OpentelemetryGrpc.Server.setup(span_relationship: :child)
72+
73+
# Create span links instead of parent-child relationships - use for fire-and-forget or detached async processing
74+
OpentelemetryGrpc.Server.setup(span_relationship: :link)
75+
76+
# Disable context propagation entirely - useful for isolated traces
77+
OpentelemetryGrpc.Server.setup(span_relationship: :none)
78+
```
79+
80+
### Advanced Configuration
81+
82+
You can pass server-specific options through the main setup function:
83+
84+
```elixir
85+
OpentelemetryGrpc.setup(server: [span_relationship: :link])
86+
```
87+
88+
## Context Propagation
89+
90+
The library supports OpenTelemetry context propagation:
91+
92+
- **Client**: Use `OpentelemetryGrpc.ContextPropagatorInterceptor` to inject trace context into outgoing requests
93+
- **Server**: Context is automatically extracted from incoming request headers (when enabled)

‎instrumentation/opentelemetry_grpc/lib/opentelemetry_grpc.ex‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
defmodule OpentelemetryGrpc do
2+
alias OpentelemetryGrpc.Client
3+
alias OpentelemetryGrpc.Server
4+
5+
@options_schema NimbleOptions.new!(
6+
server: [
7+
type:
8+
{:or,
9+
[
10+
{:keyword_list, Server.options_schema()},
11+
{:in, [:disabled]}
12+
]},
13+
default: [],
14+
doc: """
15+
Server instrumentation options. Set to `:disabled` to skip server setup. \n\n #{NimbleOptions.docs(Server.options_schema(), nest_level: 1)}
16+
"""
17+
],
18+
client: [
19+
type: {:in, [[], :disabled]},
20+
default: [],
21+
doc: """
22+
Client instrumentation. Set to `:disabled` to skip client setup.
23+
"""
24+
]
25+
)
26+
27+
@moduledoc """
28+
OpenTelemetry instrumentation for gRPC clients and servers.
29+
30+
This library provides OpenTelemetry tracing for gRPC applications, supporting
31+
both client and server instrumentation with proper context propagation.
32+
33+
## Client Instrumentation
34+
35+
To instrument gRPC client calls, set up the client telemetry handler:
36+
37+
OpentelemetryGrpc.Client.setup()
38+
39+
For context propagation in client requests, add the interceptor to your gRPC channel:
40+
41+
{:ok, channel} = GRPC.Stub.connect("localhost:50051",
42+
interceptors: [OpentelemetryGrpc.ContextPropagatorInterceptor]
43+
)
44+
45+
## Server Instrumentation
46+
47+
To instrument gRPC server requests, set up the server telemetry handler:
48+
49+
OpentelemetryGrpc.Server.setup()
50+
51+
By default, server instrumentation includes context propagation. To control span relationships:
52+
53+
OpentelemetryGrpc.Server.setup(span_relationship: :link)
54+
55+
## Complete Setup
56+
57+
To set up both client and server instrumentation:
58+
59+
OpentelemetryGrpc.setup()
60+
61+
This is equivalent to calling both `Client.setup()` and `Server.setup()`.
62+
63+
"""
64+
65+
@doc """
66+
Set up both client and server gRPC instrumentation.
67+
68+
## Options
69+
70+
#{NimbleOptions.docs(@options_schema)}
71+
72+
## Examples
73+
74+
# Basic setup
75+
OpentelemetryGrpc.setup()
76+
77+
# With server options
78+
OpentelemetryGrpc.setup(server: [span_relationship: :link])
79+
80+
# Disable client instrumentation
81+
OpentelemetryGrpc.setup(client: :disabled)
82+
83+
"""
84+
@spec setup(unquote(NimbleOptions.option_typespec(@options_schema))) :: :ok
85+
def setup(opts \\ []) do
86+
config =
87+
opts
88+
|> NimbleOptions.validate!(@options_schema)
89+
|> Enum.into(%{})
90+
91+
if config.server != :disabled do
92+
Server.setup(config.server)
93+
end
94+
95+
if config.client != :disabled do
96+
Client.setup(config.client)
97+
end
98+
99+
:ok
100+
end
101+
end

0 commit comments

Comments
 (0)