opentelemetry-metrics-sdk 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +9 -0
  3. data/CHANGELOG.md +5 -0
  4. data/LICENSE +201 -0
  5. data/README.md +110 -0
  6. data/lib/opentelemetry/sdk/metrics/aggregation/explicit_bucket_histogram.rb +100 -0
  7. data/lib/opentelemetry/sdk/metrics/aggregation/histogram_data_point.rb +27 -0
  8. data/lib/opentelemetry/sdk/metrics/aggregation/number_data_point.rb +19 -0
  9. data/lib/opentelemetry/sdk/metrics/aggregation/sum.rb +58 -0
  10. data/lib/opentelemetry/sdk/metrics/aggregation.rb +21 -0
  11. data/lib/opentelemetry/sdk/metrics/configuration_patch.rb +25 -0
  12. data/lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb +44 -0
  13. data/lib/opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter.rb +46 -0
  14. data/lib/opentelemetry/sdk/metrics/export/metric_reader.rb +36 -0
  15. data/lib/opentelemetry/sdk/metrics/export.rb +28 -0
  16. data/lib/opentelemetry/sdk/metrics/instrument/counter.rb +51 -0
  17. data/lib/opentelemetry/sdk/metrics/instrument/histogram.rb +44 -0
  18. data/lib/opentelemetry/sdk/metrics/instrument/observable_counter.rb +26 -0
  19. data/lib/opentelemetry/sdk/metrics/instrument/observable_gauge.rb +26 -0
  20. data/lib/opentelemetry/sdk/metrics/instrument/observable_up_down_counter.rb +26 -0
  21. data/lib/opentelemetry/sdk/metrics/instrument/synchronous_instrument.rb +49 -0
  22. data/lib/opentelemetry/sdk/metrics/instrument/up_down_counter.rb +44 -0
  23. data/lib/opentelemetry/sdk/metrics/instrument.rb +22 -0
  24. data/lib/opentelemetry/sdk/metrics/meter.rb +51 -0
  25. data/lib/opentelemetry/sdk/metrics/meter_provider.rb +139 -0
  26. data/lib/opentelemetry/sdk/metrics/state/metric_data.rb +25 -0
  27. data/lib/opentelemetry/sdk/metrics/state/metric_store.rb +48 -0
  28. data/lib/opentelemetry/sdk/metrics/state/metric_stream.rb +76 -0
  29. data/lib/opentelemetry/sdk/metrics/state.rb +22 -0
  30. data/lib/opentelemetry/sdk/metrics/version.rb +14 -0
  31. data/lib/opentelemetry/sdk/metrics.rb +22 -0
  32. data/lib/opentelemetry-metrics-sdk.rb +9 -0
  33. metadata +260 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 68999276f28a3e390725b6aebabc70a8846818e93fa9d6520f09c7992376bbbf
4
+ data.tar.gz: 923878943342c36c768458f3f46fa34275faaf739a5257ca2d61a0bb46eccf5e
5
+ SHA512:
6
+ metadata.gz: 4f8a1bf6946c7a1bc27955369fa540dfb1ca481b393a5e1bfd4eb9c1957b0ed404fa6c9007dbc4af0314bcbcf8eb2dfdb5ef76d838d24a87ef635016c78238ea
7
+ data.tar.gz: e487825f271ba21fe3f491cbd497635d22cd224c3ba370b6de93b22367deb2bce11867db0d60a7860152a3cf255152c922ba6c452c5f8c9a01d5563ee8733025
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Metrics SDK
3
+ --markup=markdown
4
+ --main=README.md
5
+ ./lib/opentelemetry/**/*.rb
6
+ ./lib/opentelemetry.rb
7
+ -
8
+ README.md
9
+ CHANGELOG.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # Release History: opentelemetry-metrics-sdk
2
+
3
+ ### v0.1.0 / 2024-07-31
4
+
5
+ Initial release.
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,110 @@
1
+ # opentelemetry-metrics-sdk
2
+
3
+ The `opentelemetry-metrics-sdk` is an alpha implementation of the [OpenTelemetry Metrics SDK][metrics-sdk] for Ruby. It should be used in conjunction with the `opentelemetry-sdk` to collect, analyze and export metrics.
4
+
5
+ ## What is OpenTelemetry?
6
+
7
+ [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.
8
+
9
+ OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces, metrics, and logs from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
10
+
11
+ ## How does this gem fit in?
12
+
13
+ Metrics is one of the core signals in OpenTelemetry. This package allows you to emit OpenTelemetry metrics using Ruby. It leverages an alpha implementation of the OpenTelemetry Metrics API. At the current stage, things may break and APIs may change. Use this tool with caution.
14
+
15
+ This gem does not have a full implementation of the Metrics SDK specification. The work is in progress.
16
+
17
+ At this time, you should be able to:
18
+ * Create synchronous:
19
+ * counters
20
+ * up down counters
21
+ * histograms
22
+ * observable counters
23
+ * observable gauges
24
+ * observable up down counters
25
+ * Export using a pull exporter
26
+ * Use delta aggregation temporality
27
+
28
+ We do not yet have support for:
29
+ * Asynchronous instruments
30
+ * Cumulative aggregation temporality
31
+ * Metrics Views
32
+ * Metrics Exemplars
33
+ * Periodic Exporting Metric Reader
34
+ * Push metric exporting
35
+
36
+ These lists are incomplete and are intended to give a broad description of what's available.
37
+
38
+ Until the Ruby implementation of OpenTelemetry Metrics becomes stable, the functionality to create and export metrics will remain in a gem separate from the stable features available from the `opentelemetry-sdk`.
39
+
40
+ ## How do I get started?
41
+
42
+ Install the gems using:
43
+
44
+ ```
45
+ gem install opentelemetry-metrics-sdk
46
+ gem install opentelemetry-sdk
47
+ ```
48
+
49
+ Or, if you use [bundler][bundler-home], include `opentelemetry-metrics-sdk` and `opentelemetry-sdk` in your `Gemfile`.
50
+
51
+ Then, configure the SDK according to your desired handling of telemetry data, and use the OpenTelemetry interfaces to produces traces and other information. Following is a basic example.
52
+
53
+ ```ruby
54
+ require 'opentelemetry/sdk'
55
+ require 'opentelemetry-metrics-sdk'
56
+
57
+ # Configure the sdk with default export and context propagation formats.
58
+ OpenTelemetry::SDK.configure
59
+
60
+ # Create an exporter. This example exports metrics to the console.
61
+ console_metric_exporter = OpenTelemetry::SDK::Metrics::Export::ConsoleMetricPullExporter.new
62
+
63
+ # Add the exporter to the meter provider as a new metric reader.
64
+ OpenTelemetry.meter_provider.add_metric_reader(console_metric_exporter)
65
+
66
+ # Create a meter to generate instruments.
67
+ meter = OpenTelemetry.meter_provider.meter("SAMPLE_METER_NAME")
68
+
69
+ # Create an instrument.
70
+ histogram = meter.create_histogram('histogram', unit: 'smidgen', description: 'desscription')
71
+
72
+ # Record a metric.
73
+ histogram.record(123, attributes: {'foo' => 'bar'})
74
+
75
+ # Send the recorded metrics to the metric readers.
76
+ OpenTelemetry.meter_provider.metric_readers.each(&:pull)
77
+
78
+ # Shut down the meter provider.
79
+ OpenTelemetry.meter_provider.shutdown
80
+ ```
81
+
82
+ For additional examples, see the [examples on github][examples-github].
83
+
84
+ ## How can I get involved?
85
+
86
+ The `opentelemetry-metrics-sdk` gem source is [on github][repo-github], along with related gems including `opentelemetry-sdk`.
87
+
88
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
89
+
90
+ There's still work to be done, to get to a spec-compliant metrics implementation and we'd love to have more folks contributing to the project. Check the [repo][repo-github] for issues and PRs labeled with `metrics` to see what's available.
91
+
92
+ ## Feedback
93
+
94
+ During this experimental stage, we're looking for lots of community feedback about this gem. Please add your comments to Issue [#1662][1662].
95
+
96
+ ## License
97
+
98
+ The `opentelemetry-metrics-sdk` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
99
+
100
+
101
+ [metrics-sdk]: https://opentelemetry.io/docs/specs/otel/metrics/sdk/
102
+ [opentelemetry-home]: https://opentelemetry.io
103
+ [bundler-home]: https://bundler.io
104
+ [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
105
+ [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
106
+ [examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples/
107
+ [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
108
+ [community-meetings]: https://github.com/open-telemetry/community#community-meetings
109
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
110
+ [1662]: https://github.com/open-telemetry/opentelemetry-ruby/issues/1662
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ module Aggregation
11
+ # Contains the implementation of the ExplicitBucketHistogram aggregation
12
+ # https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation
13
+ class ExplicitBucketHistogram
14
+ DEFAULT_BOUNDARIES = [0, 5, 10, 25, 50, 75, 100, 250, 500, 1000].freeze
15
+ private_constant :DEFAULT_BOUNDARIES
16
+
17
+ attr_reader :aggregation_temporality
18
+
19
+ # The default value for boundaries represents the following buckets:
20
+ # (-inf, 0], (0, 5.0], (5.0, 10.0], (10.0, 25.0], (25.0, 50.0],
21
+ # (50.0, 75.0], (75.0, 100.0], (100.0, 250.0], (250.0, 500.0],
22
+ # (500.0, 1000.0], (1000.0, +inf)
23
+ def initialize(
24
+ aggregation_temporality: ENV.fetch('OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE', :delta), # TODO: the default should be :cumulative, see issue #1555
25
+ boundaries: DEFAULT_BOUNDARIES,
26
+ record_min_max: true
27
+ )
28
+ @data_points = {}
29
+ @aggregation_temporality = aggregation_temporality
30
+ @boundaries = boundaries && !boundaries.empty? ? boundaries.sort : nil
31
+ @record_min_max = record_min_max
32
+ end
33
+
34
+ def collect(start_time, end_time)
35
+ if @aggregation_temporality == :delta
36
+ # Set timestamps and 'move' data point values to result.
37
+ hdps = @data_points.values.map! do |hdp|
38
+ hdp.start_time_unix_nano = start_time
39
+ hdp.time_unix_nano = end_time
40
+ hdp
41
+ end
42
+ @data_points.clear
43
+ hdps
44
+ else
45
+ # Update timestamps and take a snapshot.
46
+ @data_points.values.map! do |hdp|
47
+ hdp.start_time_unix_nano ||= start_time # Start time of a data point is from the first observation.
48
+ hdp.time_unix_nano = end_time
49
+ hdp = hdp.dup
50
+ hdp.bucket_counts = hdp.bucket_counts.dup
51
+ hdp
52
+ end
53
+ end
54
+ end
55
+
56
+ def update(amount, attributes)
57
+ hdp = @data_points.fetch(attributes) do
58
+ if @record_min_max
59
+ min = Float::INFINITY
60
+ max = -Float::INFINITY
61
+ end
62
+
63
+ @data_points[attributes] = HistogramDataPoint.new(
64
+ attributes,
65
+ nil, # :start_time_unix_nano
66
+ nil, # :time_unix_nano
67
+ 0, # :count
68
+ 0, # :sum
69
+ empty_bucket_counts, # :bucket_counts
70
+ @boundaries, # :explicit_bounds
71
+ nil, # :exemplars
72
+ min, # :min
73
+ max # :max
74
+ )
75
+ end
76
+
77
+ if @record_min_max
78
+ hdp.max = amount if amount > hdp.max
79
+ hdp.min = amount if amount < hdp.min
80
+ end
81
+
82
+ hdp.sum += amount
83
+ hdp.count += 1
84
+ if @boundaries
85
+ bucket_index = @boundaries.bsearch_index { |i| i >= amount } || @boundaries.size
86
+ hdp.bucket_counts[bucket_index] += 1
87
+ end
88
+ nil
89
+ end
90
+
91
+ private
92
+
93
+ def empty_bucket_counts
94
+ @boundaries ? Array.new(@boundaries.size + 1, 0) : nil
95
+ end
96
+ end
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ module Aggregation
11
+ # TODO: Deal with this later
12
+ # rubocop:disable Lint/StructNewOverride
13
+ HistogramDataPoint = Struct.new(:attributes, # optional Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}
14
+ :start_time_unix_nano, # Integer nanoseconds since Epoch
15
+ :time_unix_nano, # Integer nanoseconds since Epoch
16
+ :count, # Integer count is the number of values in the population. Must be non-negative.
17
+ :sum, # Integer sum of the values in the population. If count is zero then this field then this field must be zero
18
+ :bucket_counts, # optional Array[Integer] field contains the count values of histogram for each bucket.
19
+ :explicit_bounds, # Array[Float] specifies buckets with explicitly defined bounds for values.
20
+ :exemplars, # optional List of exemplars collected from measurements that were used to form the data point
21
+ :min, # optional Float min is the minimum value over (start_time, end_time].
22
+ :max) # optional Float max is the maximum value over (start_time, end_time].
23
+ # rubocop:enable Lint/StructNewOverride
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ module Aggregation
11
+ NumberDataPoint = Struct.new(:attributes, # Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}
12
+ :start_time_unix_nano, # Integer nanoseconds since Epoch
13
+ :time_unix_nano, # Integer nanoseconds since Epoch
14
+ :value, # Integer
15
+ :exemplars) # optional List of exemplars collected from measurements that were used to form the data point
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ module Aggregation
11
+ # Contains the implementation of the Sum aggregation
12
+ # https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#sum-aggregation
13
+ class Sum
14
+ attr_reader :aggregation_temporality
15
+
16
+ def initialize(aggregation_temporality: ENV.fetch('OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE', :delta))
17
+ # TODO: the default should be :cumulative, see issue #1555
18
+ @aggregation_temporality = aggregation_temporality
19
+ @data_points = {}
20
+ end
21
+
22
+ def collect(start_time, end_time)
23
+ if @aggregation_temporality == :delta
24
+ # Set timestamps and 'move' data point values to result.
25
+ ndps = @data_points.values.map! do |ndp|
26
+ ndp.start_time_unix_nano = start_time
27
+ ndp.time_unix_nano = end_time
28
+ ndp
29
+ end
30
+ @data_points.clear
31
+ ndps
32
+ else
33
+ # Update timestamps and take a snapshot.
34
+ @data_points.values.map! do |ndp|
35
+ ndp.start_time_unix_nano ||= start_time # Start time of a data point is from the first observation.
36
+ ndp.time_unix_nano = end_time
37
+ ndp.dup
38
+ end
39
+ end
40
+ end
41
+
42
+ def update(increment, attributes)
43
+ ndp = @data_points[attributes] || @data_points[attributes] = NumberDataPoint.new(
44
+ attributes,
45
+ nil,
46
+ nil,
47
+ 0,
48
+ nil
49
+ )
50
+
51
+ ndp.value += increment
52
+ nil
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ # The Aggregation module contains the OpenTelemetry metrics reference
11
+ # aggregation implementations.
12
+ module Aggregation
13
+ end
14
+ end
15
+ end
16
+ end
17
+
18
+ require 'opentelemetry/sdk/metrics/aggregation/number_data_point'
19
+ require 'opentelemetry/sdk/metrics/aggregation/histogram_data_point'
20
+ require 'opentelemetry/sdk/metrics/aggregation/explicit_bucket_histogram'
21
+ require 'opentelemetry/sdk/metrics/aggregation/sum'
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ # The ConfiguratorPatch implements a hook to configure the metrics
11
+ # portion of the SDK.
12
+ module ConfiguratorPatch
13
+ private
14
+
15
+ # The metrics_configuration_hook method is where we define the setup process
16
+ # for metrics SDK.
17
+ def metrics_configuration_hook
18
+ OpenTelemetry.meter_provider = Metrics::MeterProvider.new(resource: @resource)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
24
+
25
+ OpenTelemetry::SDK::Configurator.prepend(OpenTelemetry::SDK::Metrics::ConfiguratorPatch)
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SDK
9
+ module Metrics
10
+ module Export
11
+ # Outputs {MetricData} to the console
12
+ #
13
+ # Potentially useful for exploratory purposes.
14
+ class ConsoleMetricPullExporter < MetricReader
15
+ def initialize
16
+ super
17
+ @stopped = false
18
+ end
19
+
20
+ def pull
21
+ export(collect)
22
+ end
23
+
24
+ def export(metrics, timeout: nil)
25
+ return FAILURE if @stopped
26
+
27
+ Array(metrics).each { |metric| pp metric }
28
+
29
+ SUCCESS
30
+ end
31
+
32
+ def force_flush(timeout: nil)
33
+ SUCCESS
34
+ end
35
+
36
+ def shutdown(timeout: nil)
37
+ @stopped = true
38
+ SUCCESS
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end