opentelemetry-exporters-datadog 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d6a3655e5031e8d6468cfb70c94d9121d6dc24797207124066392f6215a36e0d
4
+ data.tar.gz: 2587db24b129fff673be086fe542140edf64327d783a022b2edafeee6cd64416
5
+ SHA512:
6
+ metadata.gz: d0663fcc6cadd7eb0baefa0f33251c59c380e16f42079873a2c463cbbd889b49a7123351d248afe0c6e527b090a6ed43a7d276ee6ca78d101ffc01c321856f79
7
+ data.tar.gz: 2ce86ba82c00838ad078112e016e3c8b67f7f52144d354229913861aeb0002a73a6068179897bc77eedcf370c00093d03dd9e5f0c0e2ad55e05592005fdd605c
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Datadog Exporter
3
+ --markup=markdown
4
+ --main=OVERVIEW.md
5
+ ./lib/opentelemetry/exporters/datadog/**/*.rb
6
+ ./lib/opentelemetry/exporters/datadog.rb
7
+ -
8
+ OVERVIEW.md
9
+ CHANGELOG.md
@@ -0,0 +1,13 @@
1
+ # Release History: opentelemetry-exporters-datadog
2
+
3
+ ## [Unreleased]
4
+
5
+ ## [0.1.0] - 2020-07-22
6
+ ### Added
7
+ - initial release
8
+ - add DatadogSpanProcessor
9
+ - add DatadogExporter
10
+ - add DatadogProbabilitySampler
11
+ - add DatadogPropagator
12
+ - add setup and usage instructions
13
+ - add unit tests
@@ -0,0 +1,81 @@
1
+ # Contributing
2
+
3
+ Community contributions to the Datadog Opentelemetry Exporter library for Ruby are welcome! See below for some basic guidelines.
4
+
5
+ ## Want to request a new feature?
6
+
7
+ Many great ideas for new features come from the community, and we'd be happy to consider yours!
8
+
9
+ To share your request, you can [open a Github issue](https://github.com/DataDog/dd-opentelemetry-exporter-ruby/issues/new) with the details about what you'd like to see. At a minimum, please provide:
10
+
11
+ - The goal of the new feature
12
+ - A description of how it might be used or behave
13
+ - Links to any important resources (e.g. Github repos, websites, screenshots, specifications, diagrams)
14
+
15
+ Additionally, if you can, include:
16
+
17
+ - A description of how it could be accomplished
18
+ - Code snippets that might demonstrate its use or implementation
19
+ - Screenshots or mockups that visually demonstrate the feature
20
+ - Links to similar features that would serve as a good comparison
21
+ - (Any other details that would be useful for implementing this feature!)
22
+
23
+
24
+ ## Found a bug?
25
+
26
+ For any urgent matters (such as outages) or issues concerning the Datadog service or UI, contact our support team via https://docs.datadoghq.com/help/ for direct, faster assistance.
27
+
28
+ You may submit bug reports concerning the Datadog OpenTelemetry Exporter for Ruby by [opening a Github issue](https://github.com/DataDog/dd-opentelemetry-exporter-ruby/issues/new). At a minimum, please provide:
29
+
30
+ - A description of the problem
31
+ - Steps to reproduce
32
+ - Expected behavior
33
+ - Actual behavior
34
+ - Errors (with stack traces) or warnings received
35
+ - Any details you can share about your configuration including:
36
+ - Ruby version & platform
37
+ - `opentelemetry-exporters-datadog` version
38
+ - Versions of any other relevant gems (or a `Gemfile.lock` if available)
39
+ - Any configuration settings for this library and opentelemetry-ruby trace library
40
+
41
+ If at all possible, also provide:
42
+
43
+ - Logs (from the tracer/application/agent) or other diagnostics
44
+ - Screenshots, links, or other visual aids that are publicly accessible
45
+ - Code sample or test that reproduces the problem
46
+ - An explanation of what causes the bug and/or how it can be fixed
47
+
48
+ Reports that include rich detail are better, and ones with code that reproduce the bug are best.
49
+
50
+ ## Have a patch?
51
+
52
+ We welcome code contributions to the library, which you can [submit as a pull request](https://github.com/DataDog/dd-opentelemetry-exporter-ruby/pull/new/master). To create a pull request:
53
+
54
+ 1. **Fork the repository** from https://github.com/DataDog/dd-opentelemetry-exporter-ruby
55
+ 2. **Make any changes** for your patch.
56
+ 3. **Write tests** that demonstrate how the feature works or how the bug is fixed.
57
+ 4. **Update any documentation** such as `README.md`, especially for new features.
58
+ 5. **Submit the pull request** from your fork back to https://github.com/DataDog/dd-opentelemetry-exporter-ruby. Bugs should merge back to `master`.
59
+
60
+ The pull request will be run through our CI pipeline, and a project member will review the changes with you. At a minimum, to be accepted and merged, pull requests must:
61
+
62
+ - Have a stated goal and detailed description of the changes made
63
+ - Include thorough test coverage and documentation, where applicable
64
+ - Pass all tests and code quality checks (linting/coverage/benchmarks) on CI
65
+ - Receive at least one approval from a project member with push permissions
66
+
67
+ We also recommend that you share in your description:
68
+
69
+ - Any motivations or intent for the contribution
70
+ - Links to any issues/pull requests it might be related to
71
+ - Links to any webpages or other external resources that might be related to the change
72
+ - Screenshots, code samples, or other visual aids that demonstrate the changes or how they are implemented
73
+ - Benchmarks if the feature is anticipated to have performance implications
74
+ - Any limitations, constraints or risks that are important to consider
75
+
76
+
77
+ ## Final word
78
+
79
+ Many thanks to all of our contributors, and looking forward to seeing you on Github! :tada:
80
+
81
+ - Datadog Ruby APM Team
data/LICENSE ADDED
@@ -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 2020 OpenTelemetry Authors
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.
@@ -0,0 +1,172 @@
1
+ **[BETA]**
2
+
3
+ # opentelemetry-exporters-datadog
4
+
5
+ The `opentelemetry-exporters-datadog` gem provides a Datadog exporter for OpenTelemetry for Ruby. Using `opentelemetry-exporters-datadog`, an application can configure OpenTelemetry to export collected tracing data to [Datadog][datadog-home].
6
+
7
+ ## What is OpenTelemetry?
8
+
9
+ [OpenTelemetry][opentelemetry-home] is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
10
+
11
+ OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application.
12
+
13
+ ## How does this gem fit in?
14
+
15
+ The `opentelemetry-exporters-datadog` gem is a plugin that provides Datadog Tracing export. To export to Datadog, an application can include this gem along with `opentelemetry-sdk`, and configure the `SDK` to use the provided Datadog exporter as a span processor.
16
+
17
+ Generally, *libraries* that produce telemetry data should avoid depending directly on specific exporters, deferring that choice to the application developer.
18
+
19
+ ## Setup
20
+
21
+ - If you use [bundler][bundler-home], include the following in your `Gemfile`:
22
+
23
+ ```
24
+ gem 'opentelemetry-exporters-datadog'
25
+ gem 'opentelemetry-api', '~> 0.5'
26
+ gem 'opentelemetry-sdk', '~> 0.5'
27
+ ```
28
+
29
+ - Or install the gem directly using:
30
+
31
+ ```
32
+ gem install opentelemetry-api
33
+ gem install opentelemetry-sdk
34
+ gem install opentelemetry-exporters-datadog
35
+ ```
36
+
37
+ - Then, configure the SDK to use the Datadog exporter as a span processor, and use the OpenTelemetry interfaces to produces traces and other information. Following is a basic example.
38
+
39
+ ```ruby
40
+ require 'opentelemetry/sdk'
41
+ require 'opentelemetry-exporters-datadog'
42
+
43
+ # Configure the sdk with custom export
44
+ OpenTelemetry::SDK.configure do |c|
45
+ c.add_span_processor(
46
+ OpenTelemetry::Exporters::Datadog::DatadogSpanProcessor.new(
47
+ OpenTelemetry::Exporters::Datadog::Exporter.new(
48
+ service_name: 'my_service', agent_url: 'http://localhost:8126'
49
+ )
50
+ )
51
+ )
52
+ end
53
+
54
+ # For propagation of datadog specific distibuted tracing headers,
55
+ # set http propagation to the Composite Propagator
56
+
57
+ OpenTelemetry::Exporters::Datadog::Propagator.auto_configure
58
+
59
+ # For manual configuration of propagation of datadog specific distibuted tracing headers,
60
+ # add the Datadog Propagator to the list of extractors and injectors, like below
61
+
62
+ # extractors = [
63
+ # OpenTelemetry::Trace::Propagation::TraceContext.rack_extractor,
64
+ # OpenTelemetry::CorrelationContext::Propagation.rack_extractor,
65
+ # OpenTelemetry::Exporters::Datadog::Propagator.new
66
+ # ]
67
+ # injectors = [
68
+ # OpenTelemetry::Trace::Propagation::TraceContext.text_injector,
69
+ # OpenTelemetry::CorrelationContext::Propagation.text_injector,
70
+ # OpenTelemetry::Exporters::Datadog::Propagator.new
71
+ # ]
72
+ # OpenTelemetry.propagation.http = OpenTelemetry::Context::Propagation::CompositePropagator.new(injectors, extractors)
73
+
74
+ # To start a trace you need to get a Tracer from the TracerProvider
75
+ tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
76
+
77
+ # create a span
78
+ tracer.in_span('foo') do |span|
79
+ # set an attribute
80
+ span.set_attribute('platform', 'osx')
81
+ # add an event
82
+ span.add_event(name: 'event in bar')
83
+ # create bar as child of foo
84
+ tracer.in_span('bar') do |child_span|
85
+ # inspect the span
86
+ pp child_span
87
+ end
88
+ end
89
+ ```
90
+
91
+ For additional examples, see the [examples on github][examples-github].
92
+
93
+ ## Probability Based Sampling Setup
94
+
95
+ - By default, the OpenTelemetry tracer will sample and record all spans. This default is the suggest sampling approach to take when exporting to Datadog. However, if you wish to use Probability Based sampling, we recommend that, in order for the Datadog trace-agent to collect trace related metrics effectively, to use the `DatadogProbabilitySampler`. You can enabled Datadog Probability based sampling with the code snippet below.
96
+
97
+ ```ruby
98
+ #sampling rate must be a value between 0.0 and 1.0
99
+ sampling_rate = 0.75
100
+ OpenTelemetry.tracer_provider.active_trace_config = OpenTelemetry::SDK::Tracer::Config::Tracer::TraceConfig.new(
101
+ sampler: OpenTelemetry::SDK::Trace::Export::DatadogProbabilitySampler.default_with_probability(sampling_rate)
102
+ )
103
+ ```
104
+
105
+ ## Configuration Options
106
+
107
+ #### Configuration Options - Datadog Agent URL
108
+
109
+ By default the OpenTelemetry Datadog Exporter transmits traces to localhost:8126. You can configure the application to send traces to a diffent URL using the following environmennt variables:
110
+
111
+ - `DD_TRACE_AGENT_URL`: The `<host>:<port:` where you Datadog Agent is listening for traces. (e.g. `agent-host:8126`)
112
+
113
+ These values can also be overridden at the trace exporter level:
114
+
115
+ ```ruby
116
+ # Configure the sdk with custom export
117
+ OpenTelemetry::SDK.configure do |c|
118
+ c.add_span_processor(
119
+ OpenTelemetry::Exporters::Datadog::DatadogSpanProcessor.new(
120
+ OpenTelemetry::Exporters::Datadog::Exporter.new(
121
+ service_name: 'my_service',
122
+ agent_url: 'http://dd-agent:8126',
123
+ )
124
+ )
125
+ )
126
+ end
127
+ ```
128
+
129
+ #### Configuration Options - Tagging
130
+
131
+ You can configure the application to automatically tag your Datadog exported traces, using the following environment variables:
132
+
133
+ - `DD_ENV`: Your application environment (e.g. `production`, `staging`, etc.)
134
+ - `DD_SERVICE`: Your application's default service name (e.g. `billing-api`)
135
+ - `DD_VERSION`: Your application version (e.g. `2.5`, `202003181415`, `1.3-alpha`, etc.)
136
+ - `DD_TAGS`: Custom tags in value pairs separated by `,` (e.g. `layer:api,team:intake`)
137
+ - If `DD_ENV`, `DD_SERVICE` or `DD_VERSION` are set, it will override any respective `env`/`service`/`version` tag defined in `DD_TAGS`.
138
+ - If `DD_ENV`, `DD_SERVICE` or `DD_VERSION` are NOT set, tags defined in `DD_TAGS` will be used to populate `env`/`service`/`version` respectively.
139
+
140
+ These values can also be overridden at the trace exporter level:
141
+
142
+ ```ruby
143
+ # Configure the sdk with custom export
144
+ OpenTelemetry::SDK.configure do |c|
145
+ c.add_span_processor(
146
+ OpenTelemetry::Exporters::Datadog::DatadogSpanProcessor.new(
147
+ OpenTelemetry::Exporters::Datadog::Exporter.new(
148
+ service_name: 'my_service',
149
+ agent_url: 'http://localhost:8126',
150
+ env: 'prod',
151
+ version: '1.5-alpha',
152
+ tags: 'team:ops,region:west'
153
+ )
154
+ )
155
+ )
156
+ end
157
+ ```
158
+
159
+ This enables you to set this value on a per application basis, so you can have for example several applications reporting for different environments on the same host.
160
+
161
+ Tags can also be set directly on individual spans, which will supersede any conflicting tags defined at the application level.
162
+
163
+ ## License
164
+
165
+ The `opentelemetry-exporters-datadog` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
166
+
167
+
168
+ [datadog-home]: https://www.datadoghq.com
169
+ [opentelemetry-home]: https://opentelemetry.io
170
+ [bundler-home]: https://bundler.io
171
+ [license-github]: https://github.com/DataDog/dd-opentelemetry-exporter-ruby/blob/master/LICENSE
172
+ [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/examples