aspecto-opentelemetry 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rubocop.yml +32 -0
- data/CHANGELOG.md +5 -0
- data/Gemfile +5 -0
- data/LICENSE +201 -0
- data/README.md +82 -0
- data/Rakefile +15 -0
- data/lib/aspecto/auto_instrument.rb +5 -0
- data/lib/aspecto/opentelemetry/configurator.rb +39 -0
- data/lib/aspecto/opentelemetry/resource/detectors/aspecto.rb +25 -0
- data/lib/aspecto/opentelemetry/resource/detectors/deployment.rb +49 -0
- data/lib/aspecto/opentelemetry/version.rb +7 -0
- data/lib/aspecto/opentelemetry.rb +70 -0
- metadata +156 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: a2bcc099a425ea9d9d4ea5279fcdde5fd1c72ee7a747cac0db749ec4946e6400
|
4
|
+
data.tar.gz: 4045a1f967fc690eb67d057311f8543924abb14a223fd6484135e3831bc1fa11
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5abe512f0a006febca0d20dab3dc2600539ef5af63429e3f05e715278e2760f611cc85908176a08e84a5570a045d02fd6baba260a8b769b691e9ad13f8d29abd
|
7
|
+
data.tar.gz: f37300481a7a2994eb99600ed22fd122abaae7afe2569f36beb342f79204320b8726125fdb226adf1114169b178f6b7f43ff93c482c3d8b682681c9503d4579a
|
data/.rubocop.yml
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
AllCops:
|
2
|
+
TargetRubyVersion: "2.5.0"
|
3
|
+
|
4
|
+
Style/StringLiterals:
|
5
|
+
Enabled: true
|
6
|
+
EnforcedStyle: double_quotes
|
7
|
+
|
8
|
+
Style/StringLiteralsInInterpolation:
|
9
|
+
Enabled: true
|
10
|
+
EnforcedStyle: double_quotes
|
11
|
+
|
12
|
+
Lint/UnusedMethodArgument:
|
13
|
+
Enabled: false
|
14
|
+
|
15
|
+
Metrics/AbcSize:
|
16
|
+
Max: 18
|
17
|
+
|
18
|
+
Metrics/LineLength:
|
19
|
+
Enabled: false
|
20
|
+
|
21
|
+
Metrics/MethodLength:
|
22
|
+
Max: 20
|
23
|
+
|
24
|
+
Metrics/ParameterLists:
|
25
|
+
Enabled: false
|
26
|
+
|
27
|
+
Style/FrozenStringLiteralComment:
|
28
|
+
Exclude:
|
29
|
+
- gemfiles/**/*
|
30
|
+
|
31
|
+
Style/ModuleFunction:
|
32
|
+
Enabled: false
|
data/CHANGELOG.md
ADDED
data/Gemfile
ADDED
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 The 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.
|
data/README.md
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
# Aspecto::OpenTelemetry
|
2
|
+
|
3
|
+
Aspecto's SDK for ruby. This gem is a distribution of OpenTelemetry configured to use all available instrumentations and export trace data to Aspecto.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'aspecto-opentelemetry'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle install
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install aspecto-opentelemetry
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
### Auto Instrumentation
|
24
|
+
|
25
|
+
Does not require code changes. Just modify you `Gemfile` to add `require` like this:
|
26
|
+
|
27
|
+
```
|
28
|
+
gem 'aspecto-opentelemetry', require: 'aspecto/auto_instrument'
|
29
|
+
```
|
30
|
+
|
31
|
+
When using auto-instrumentation, you need to pass relevant configuration options via environment variables.
|
32
|
+
|
33
|
+
### Manual Instrumentation
|
34
|
+
|
35
|
+
Allow you to configure the SDK via code:
|
36
|
+
|
37
|
+
```rb
|
38
|
+
require 'aspecto/opentelemetry'
|
39
|
+
|
40
|
+
Aspecto::OpenTelemetry::configure
|
41
|
+
```
|
42
|
+
|
43
|
+
Add this code at the beginning of your application.
|
44
|
+
For rails - add this code to a file `aspecto.rb` under `config/initializers/`.
|
45
|
+
|
46
|
+
## Configuration
|
47
|
+
|
48
|
+
You can set configuration it 2 ways: via environment variables or via code.
|
49
|
+
The only required config options are `aspecto_auth` and `service_name`.
|
50
|
+
|
51
|
+
### Configuration in Code
|
52
|
+
|
53
|
+
```rb
|
54
|
+
require 'aspecto/opentelemetry'
|
55
|
+
|
56
|
+
Aspecto::OpenTelemetry::configure do |c|
|
57
|
+
c.service_name = 'MY_SERIVCE'
|
58
|
+
c.aspecto_auth = 'YOUR_TOKEN_HERE'
|
59
|
+
c.env = 'MY_COOL_ENV'
|
60
|
+
c.sampling_ratio = 0.1
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Configuration Options
|
65
|
+
|
66
|
+
| Option Name | Environment Variable | Type | Default | Description |
|
67
|
+
| -------------- | ---------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
68
|
+
| aspecto_auth | ASPECTO_AUTH | UUID string | - | Aspecto's [API key for authentication](https://app.aspecto.io/app/integration/api-key) |
|
69
|
+
| service_name | OTEL_SERVICE_NAME | string | - | name of the service which is sending telemetry |
|
70
|
+
| env | ASPECTO_ENV | string | extracted from rails or sinatra if used | deployment environment: `"production"` / `"staging"` / `"development"`, etc. |
|
71
|
+
| log_level | OTEL_LOG_LEVEL | string | 'ERROR' | `"ERROR"` / `"WARN"` / `"INFO"`, etc. |
|
72
|
+
| sampling_ratio | ASPECTO_SAMPLING_RATIO | float | 1.0 | How many of the traces starting in this service should be sampled. set to number in range [0.0, 1.0] where 0.0 is no sampling, and 1.0 is sample all |
|
73
|
+
|
74
|
+
## Development
|
75
|
+
|
76
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
77
|
+
|
78
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
79
|
+
|
80
|
+
## Contributing
|
81
|
+
|
82
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/aspecto-io/aspecto-opentelemetry-ruby.
|
data/Rakefile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "bundler/gem_tasks"
|
4
|
+
require "rake/testtask"
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |t|
|
7
|
+
require "rubocop/rake_task"
|
8
|
+
RuboCop::RakeTask.new
|
9
|
+
|
10
|
+
t.libs << "test"
|
11
|
+
t.libs << "lib"
|
12
|
+
t.test_files = FileList["test/**/*_test.rb"]
|
13
|
+
end
|
14
|
+
|
15
|
+
task default: %i[test rubocop]
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aspecto
|
4
|
+
module OpenTelemetry
|
5
|
+
# Aspecto OpenTelemetry Distro Configurator
|
6
|
+
class Configurator
|
7
|
+
def initialize
|
8
|
+
# initialize config options from environment variables.
|
9
|
+
# they can later be overwritten with configurator attribute setters
|
10
|
+
# that have precedence over env
|
11
|
+
@override_resource_attributes = {}
|
12
|
+
self.aspecto_auth = ENV["ASPECTO_AUTH"]
|
13
|
+
self.log_level = ENV.fetch("OTEL_LOG_LEVEL", Logger::ERROR)
|
14
|
+
self.env = ENV["ASPECTO_ENV"] if ENV["ASPECTO_ENV"]
|
15
|
+
self.sampling_ratio = Float(ENV.fetch("ASPECTO_SAMPLING_RATIO", 1.0))
|
16
|
+
end
|
17
|
+
|
18
|
+
def service_name=(service_name)
|
19
|
+
@override_resource_attributes[::OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME] = service_name
|
20
|
+
end
|
21
|
+
|
22
|
+
def env=(env)
|
23
|
+
@override_resource_attributes[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = env
|
24
|
+
end
|
25
|
+
|
26
|
+
attr_accessor :sampling_ratio, :log_level
|
27
|
+
attr_reader :aspecto_auth
|
28
|
+
|
29
|
+
def aspecto_auth=(aspecto_auth)
|
30
|
+
@override_resource_attributes["aspecto.token"] = aspecto_auth
|
31
|
+
@aspecto_auth = aspecto_auth
|
32
|
+
end
|
33
|
+
|
34
|
+
def config_override_resource
|
35
|
+
::OpenTelemetry::SDK::Resources::Resource.create(@override_resource_attributes)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../version"
|
4
|
+
require "securerandom"
|
5
|
+
|
6
|
+
module Aspecto
|
7
|
+
module OpenTelemetry
|
8
|
+
module Resource
|
9
|
+
module Detectors
|
10
|
+
# Aspecto OpenTelemetry Resource Detector
|
11
|
+
module Aspecto
|
12
|
+
extend self
|
13
|
+
|
14
|
+
def detect
|
15
|
+
resource_attributes = {}
|
16
|
+
resource_attributes["aspecto.version"] = ::Aspecto::OpenTelemetry::VERSION
|
17
|
+
# this should eventually be set in service detector
|
18
|
+
resource_attributes[::OpenTelemetry::SemanticConventions::Resource::SERVICE_INSTANCE_ID] = SecureRandom.uuid
|
19
|
+
::OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Aspecto
|
4
|
+
module OpenTelemetry
|
5
|
+
module Resource
|
6
|
+
module Detectors
|
7
|
+
# Deployment contains detect class method for determining deployment resource attributes
|
8
|
+
module Deployment
|
9
|
+
extend self
|
10
|
+
|
11
|
+
def detect
|
12
|
+
resource_attributes = {}
|
13
|
+
deployment_environment = rails_env || sinatra_env || rack_env
|
14
|
+
resource_attributes[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = deployment_environment if deployment_environment
|
15
|
+
::OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
|
20
|
+
def rails_env
|
21
|
+
# rails extract env like this:
|
22
|
+
# https://github.com/rails/rails/blob/5647a9c1ced68d20338552d47a3b755e10a271c4/railties/lib/rails.rb#L74
|
23
|
+
# ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development")
|
24
|
+
::Rails.env.to_s if defined?(::Rails.env)
|
25
|
+
end
|
26
|
+
|
27
|
+
def rack_env
|
28
|
+
ENV["RACK_ENV"]
|
29
|
+
end
|
30
|
+
|
31
|
+
def sinatra_env
|
32
|
+
# https://github.com/sinatra/sinatra/blob/e69b6b9dee7165d3a583fc8a6af10ceee1ea687d/lib/sinatra/base.rb#L1801
|
33
|
+
# cases:
|
34
|
+
#
|
35
|
+
# 1. if sinatra is "require"d before the detector, then we return the value from the library
|
36
|
+
# this case will return the default "development" fallback if not env variable is set which is good.
|
37
|
+
#
|
38
|
+
# 2. if sinatra is "require"d after the detector, then:
|
39
|
+
# 2.1 if user is setting environment via 'APP_ENV' or 'RACK_ENV' then those value will be picked up and reported
|
40
|
+
# 2.2 else, the sinatra environment will fallback to "development", but detector will return nil for it.
|
41
|
+
# this issue is not covered, as when detector initialize the immutable resource, it has no way
|
42
|
+
# of knowing if "sinatra" will be required later or not.
|
43
|
+
(::Sinatra::Base.environment.to_s if defined?(::Sinatra::Base.environment)) || ENV["APP_ENV"]
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,70 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "opentelemetry/version"
|
4
|
+
require_relative "opentelemetry/configurator"
|
5
|
+
require_relative "opentelemetry/resource/detectors/aspecto"
|
6
|
+
require_relative "opentelemetry/resource/detectors/deployment"
|
7
|
+
require "opentelemetry/sdk"
|
8
|
+
require "opentelemetry/exporter/otlp"
|
9
|
+
require "opentelemetry/instrumentation/all"
|
10
|
+
require "opentelemetry-instrumentation-aws_sdk"
|
11
|
+
|
12
|
+
module Aspecto
|
13
|
+
# Aspecto OpenTelemetry Distro
|
14
|
+
module OpenTelemetry
|
15
|
+
module_function
|
16
|
+
|
17
|
+
class Error < StandardError; end
|
18
|
+
|
19
|
+
def configure # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
|
20
|
+
configurator = Configurator.new
|
21
|
+
yield configurator if block_given?
|
22
|
+
|
23
|
+
validate_configurator_options(configurator)
|
24
|
+
|
25
|
+
::OpenTelemetry::SDK.configure do |c|
|
26
|
+
c.logger = Logger.new($stdout, level: configurator.log_level)
|
27
|
+
c.resource = Aspecto::OpenTelemetry::Resource::Detectors::Aspecto.detect
|
28
|
+
c.resource = Aspecto::OpenTelemetry::Resource::Detectors::Deployment.detect
|
29
|
+
c.resource = configurator.config_override_resource # must be last
|
30
|
+
c.use_all "OpenTelemetry::Instrumentation::ActionPack" => { enable_recognize_route: true },
|
31
|
+
"OpenTelemetry::Instrumentation::AwsSdk" => { suppress_internal_instrumentation: true }
|
32
|
+
|
33
|
+
c.add_span_processor(
|
34
|
+
::OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
|
35
|
+
::OpenTelemetry::Exporter::OTLP::Exporter.new(endpoint: "https://otelcol.aspecto.io/v1/trace", headers: {
|
36
|
+
"Authorization" => configurator.aspecto_auth
|
37
|
+
})
|
38
|
+
)
|
39
|
+
)
|
40
|
+
end
|
41
|
+
|
42
|
+
::OpenTelemetry.tracer_provider.sampler = ::OpenTelemetry::SDK::Trace::Samplers.parent_based(root: ::OpenTelemetry::SDK::Trace::Samplers.trace_id_ratio_based(configurator.sampling_ratio))
|
43
|
+
rescue StandardError => e
|
44
|
+
warn "Failed to initialize Aspecto tracing."
|
45
|
+
warn e
|
46
|
+
end
|
47
|
+
|
48
|
+
def validate_configurator_options(configurator)
|
49
|
+
# aspecto_auth
|
50
|
+
unless configurator.aspecto_auth.instance_of?(String)
|
51
|
+
raise "
|
52
|
+
Unable to retrieve Aspecto token.
|
53
|
+
In order for the Aspecto service to work, it requires an auth token.
|
54
|
+
Please provide it through ASPECTO_AUTH env param OR aspecto_auth configure option.
|
55
|
+
You can get the token from: https://app.aspecto.io/app/integration/api-key
|
56
|
+
For more details please check: https://docs.aspecto.io
|
57
|
+
|
58
|
+
"
|
59
|
+
end
|
60
|
+
|
61
|
+
# sampling_ratio
|
62
|
+
unless (configurator.sampling_ratio.is_a?(Numeric) || configurator.sampling_ratio.is_a?(String)) && Float(configurator.sampling_ratio).between?(0, 1) # rubocop:disable Style/GuardClause
|
63
|
+
raise "
|
64
|
+
sampling_ratio should be number in range [0.0, 1.0], received #{configurator.sampling_ratio}
|
65
|
+
|
66
|
+
"
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
metadata
ADDED
@@ -0,0 +1,156 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aspecto-opentelemetry
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Aspecto
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2021-11-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aspecto-opentelemetry-instrumentation-aws_sdk
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.1.3
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.1.3
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: opentelemetry-exporter-otlp
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.20.6
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 0.20.6
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: opentelemetry-instrumentation-all
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: 0.21.3
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 0.21.3
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: opentelemetry-sdk
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - '='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '5.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rake
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '13.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '13.0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rubocop
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '1.7'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '1.7'
|
111
|
+
description:
|
112
|
+
email:
|
113
|
+
- support@aspecto.io
|
114
|
+
executables: []
|
115
|
+
extensions: []
|
116
|
+
extra_rdoc_files: []
|
117
|
+
files:
|
118
|
+
- ".rubocop.yml"
|
119
|
+
- CHANGELOG.md
|
120
|
+
- Gemfile
|
121
|
+
- LICENSE
|
122
|
+
- README.md
|
123
|
+
- Rakefile
|
124
|
+
- lib/aspecto/auto_instrument.rb
|
125
|
+
- lib/aspecto/opentelemetry.rb
|
126
|
+
- lib/aspecto/opentelemetry/configurator.rb
|
127
|
+
- lib/aspecto/opentelemetry/resource/detectors/aspecto.rb
|
128
|
+
- lib/aspecto/opentelemetry/resource/detectors/deployment.rb
|
129
|
+
- lib/aspecto/opentelemetry/version.rb
|
130
|
+
homepage: https://docs.aspecto.io/
|
131
|
+
licenses:
|
132
|
+
- Apache-2.0
|
133
|
+
metadata:
|
134
|
+
homepage_uri: https://docs.aspecto.io/
|
135
|
+
source_code_uri: https://github.com/aspecto-io/aspecto-opentelemetry-ruby
|
136
|
+
changelog_uri: https://github.com/aspecto-io/aspecto-opentelemetry-ruby/CHANGELOG.md
|
137
|
+
post_install_message:
|
138
|
+
rdoc_options: []
|
139
|
+
require_paths:
|
140
|
+
- lib
|
141
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: 2.5.0
|
146
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
147
|
+
requirements:
|
148
|
+
- - ">="
|
149
|
+
- !ruby/object:Gem::Version
|
150
|
+
version: '0'
|
151
|
+
requirements: []
|
152
|
+
rubygems_version: 3.1.6
|
153
|
+
signing_key:
|
154
|
+
specification_version: 4
|
155
|
+
summary: Aspecto SDK and OpenTelemetry distribution for ruby programming language
|
156
|
+
test_files: []
|