diff options
Diffstat (limited to 'vendor/github.com/technologize')
7 files changed, 520 insertions, 0 deletions
diff --git a/vendor/github.com/technologize/otel-go-contrib/LICENSE b/vendor/github.com/technologize/otel-go-contrib/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/config.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/config.go new file mode 100644 index 000000000..f33fe38ed --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/config.go @@ -0,0 +1,45 @@ +package otelginmetrics + +import ( + "net/http" + + "go.opentelemetry.io/otel/attribute" + semconv "go.opentelemetry.io/otel/semconv/v1.7.0" +) + +type config struct { + recordInFlight bool + recordSize bool + recordDuration bool + groupedStatus bool + recorder Recorder + attributes func(serverName, route string, request *http.Request) []attribute.KeyValue + shouldRecord func(serverName, route string, request *http.Request) bool +} + +func defaultConfig() *config { + return &config{ + recordInFlight: true, + recordDuration: true, + recordSize: true, + groupedStatus: true, + attributes: DefaultAttributes, + shouldRecord: func(_, _ string, _ *http.Request) bool { + return true + }, + } +} + +var DefaultAttributes = func(serverName, route string, request *http.Request) []attribute.KeyValue { + attrs := []attribute.KeyValue{ + semconv.HTTPMethodKey.String(request.Method), + } + + if serverName != "" { + attrs = append(attrs, semconv.HTTPServerNameKey.String(serverName)) + } + if route != "" { + attrs = append(attrs, semconv.HTTPRouteKey.String(route)) + } + return attrs +} diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/middleware.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/middleware.go new file mode 100644 index 000000000..85479c7f1 --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/middleware.go @@ -0,0 +1,94 @@ +package otelginmetrics + +import ( + "net/http" + "time" + + "github.com/gin-gonic/gin" + semconv "go.opentelemetry.io/otel/semconv/v1.7.0" +) + +// Middleware returns middleware that will trace incoming requests. +// The service parameter should describe the name of the (virtual) +// server handling the request. +func Middleware(service string, options ...Option) gin.HandlerFunc { + cfg := defaultConfig() + for _, option := range options { + option.apply(cfg) + } + recorder := cfg.recorder + if recorder == nil { + recorder = GetRecorder("") + } + return func(ginCtx *gin.Context) { + + ctx := ginCtx.Request.Context() + + route := ginCtx.FullPath() + if len(route) <= 0 { + route = "nonconfigured" + } + if !cfg.shouldRecord(service, route, ginCtx.Request) { + ginCtx.Next() + return + } + + start := time.Now() + reqAttributes := cfg.attributes(service, route, ginCtx.Request) + + if cfg.recordInFlight { + recorder.AddInflightRequests(ctx, 1, reqAttributes) + defer recorder.AddInflightRequests(ctx, -1, reqAttributes) + } + + defer func() { + + resAttributes := append(reqAttributes[0:0], reqAttributes...) + + if cfg.groupedStatus { + code := int(ginCtx.Writer.Status()/100) * 100 + resAttributes = append(resAttributes, semconv.HTTPStatusCodeKey.Int(code)) + } else { + resAttributes = append(resAttributes, semconv.HTTPAttributesFromHTTPStatusCode(ginCtx.Writer.Status())...) + } + + recorder.AddRequests(ctx, 1, resAttributes) + + if cfg.recordSize { + requestSize := computeApproximateRequestSize(ginCtx.Request) + recorder.ObserveHTTPRequestSize(ctx, requestSize, resAttributes) + recorder.ObserveHTTPResponseSize(ctx, int64(ginCtx.Writer.Size()), resAttributes) + } + + if cfg.recordDuration { + recorder.ObserveHTTPRequestDuration(ctx, time.Since(start), resAttributes) + } + }() + + ginCtx.Next() + } +} + +func computeApproximateRequestSize(r *http.Request) int64 { + s := 0 + if r.URL != nil { + s = len(r.URL.Path) + } + + s += len(r.Method) + s += len(r.Proto) + for name, values := range r.Header { + s += len(name) + for _, value := range values { + s += len(value) + } + } + s += len(r.Host) + + // N.B. r.Form and r.MultipartForm are assumed to be included in r.URL. + + if r.ContentLength != -1 { + s += int(r.ContentLength) + } + return int64(s) +} diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/option.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/option.go new file mode 100644 index 000000000..144ef9378 --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/option.go @@ -0,0 +1,74 @@ +package otelginmetrics + +import ( + "net/http" + + "go.opentelemetry.io/otel/attribute" +) + +// Option applies a configuration to the given config +type Option interface { + apply(cfg *config) +} + +type optionFunc func(cfg *config) + +func (fn optionFunc) apply(cfg *config) { + fn(cfg) +} + +// WithAttributes sets a func using which what attributes to be recorded can be specified. +// By default the DefaultAttributes is used +func WithAttributes(attributes func(serverName, route string, request *http.Request) []attribute.KeyValue) Option { + return optionFunc(func(cfg *config) { + cfg.attributes = attributes + }) +} + +// WithRecordInFlight determines whether to record In Flight Requests or not +// By default the recordInFlight is true +func WithRecordInFlightDisabled() Option { + return optionFunc(func(cfg *config) { + cfg.recordInFlight = false + }) +} + +// WithRecordDuration determines whether to record Duration of Requests or not +// By default the recordDuration is true +func WithRecordDurationDisabled() Option { + return optionFunc(func(cfg *config) { + cfg.recordDuration = false + }) +} + +// WithRecordSize determines whether to record Size of Requests and Responses or not +// By default the recordSize is true +func WithRecordSizeDisabled() Option { + return optionFunc(func(cfg *config) { + cfg.recordSize = false + }) +} + +// WithGroupedStatus determines whether to group the response status codes or not. If true 2xx, 3xx will be stored +// By default the groupedStatus is true +func WithGroupedStatusDisabled() Option { + return optionFunc(func(cfg *config) { + cfg.groupedStatus = false + }) +} + +// WithRecorder sets a recorder for recording requests +// By default the open telemetry recorder is used +func WithRecorder(recorder Recorder) Option { + return optionFunc(func(cfg *config) { + cfg.recorder = recorder + }) +} + +// WithShouldRecordFunc sets a func using which whether a record should be recorded +// By default the all api calls are recorded +func WithShouldRecordFunc(shouldRecord func(serverName, route string, request *http.Request) bool) Option { + return optionFunc(func(cfg *config) { + cfg.shouldRecord = shouldRecord + }) +} diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/otelrecorder.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/otelrecorder.go new file mode 100644 index 000000000..efdc96ffd --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/otelrecorder.go @@ -0,0 +1,70 @@ +package otelginmetrics + +import ( + "context" + "time" + + "go.opentelemetry.io/otel" + "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/metric" +) + +const instrumentationName = "github.com/technologize/otel-go-contrib/otelginmetrics" + +// Recorder knows how to record and measure the metrics. This +// has the required methods to be used with the HTTP +// middlewares. +type otelRecorder struct { + attemptsCounter metric.Int64UpDownCounter + totalDuration metric.Int64Histogram + activeRequestsCounter metric.Int64UpDownCounter + requestSize metric.Int64Histogram + responseSize metric.Int64Histogram +} + +func GetRecorder(metricsPrefix string) Recorder { + metricName := func(metricName string) string { + if len(metricsPrefix) > 0 { + return metricsPrefix + "." + metricName + } + return metricName + } + meter := otel.Meter(instrumentationName, metric.WithInstrumentationVersion(SemVersion())) + attemptsCounter, _ := meter.Int64UpDownCounter(metricName("http.server.request_count"), metric.WithDescription("Number of Requests"), metric.WithUnit("Count")) + totalDuration, _ := meter.Int64Histogram(metricName("http.server.duration"), metric.WithDescription("Time Taken by request"), metric.WithUnit("Milliseconds")) + activeRequestsCounter, _ := meter.Int64UpDownCounter(metricName("http.server.active_requests"), metric.WithDescription("Number of requests inflight"), metric.WithUnit("Count")) + requestSize, _ := meter.Int64Histogram(metricName("http.server.request_content_length"), metric.WithDescription("Request Size"), metric.WithUnit("Bytes")) + responseSize, _ := meter.Int64Histogram(metricName("http.server.response_content_length"), metric.WithDescription("Response Size"), metric.WithUnit("Bytes")) + return &otelRecorder{ + attemptsCounter: attemptsCounter, + totalDuration: totalDuration, + activeRequestsCounter: activeRequestsCounter, + requestSize: requestSize, + responseSize: responseSize, + } +} + +// AddRequests increments the number of requests being processed. +func (r *otelRecorder) AddRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue) { + r.attemptsCounter.Add(ctx, quantity, metric.WithAttributes(attributes...)) +} + +// ObserveHTTPRequestDuration measures the duration of an HTTP request. +func (r *otelRecorder) ObserveHTTPRequestDuration(ctx context.Context, duration time.Duration, attributes []attribute.KeyValue) { + r.totalDuration.Record(ctx, int64(duration/time.Millisecond), metric.WithAttributes(attributes...)) +} + +// ObserveHTTPRequestSize measures the size of an HTTP request in bytes. +func (r *otelRecorder) ObserveHTTPRequestSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue) { + r.requestSize.Record(ctx, sizeBytes, metric.WithAttributes(attributes...)) +} + +// ObserveHTTPResponseSize measures the size of an HTTP response in bytes. +func (r *otelRecorder) ObserveHTTPResponseSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue) { + r.responseSize.Record(ctx, sizeBytes, metric.WithAttributes(attributes...)) +} + +// AddInflightRequests increments and decrements the number of inflight request being processed. +func (r *otelRecorder) AddInflightRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue) { + r.activeRequestsCounter.Add(ctx, quantity, metric.WithAttributes(attributes...)) +} diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/recorder.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/recorder.go new file mode 100644 index 000000000..7fadeff38 --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/recorder.go @@ -0,0 +1,25 @@ +package otelginmetrics + +import ( + "context" + "time" + + "go.opentelemetry.io/otel/attribute" +) + +type Recorder interface { + // AddRequests increments the number of requests being processed. + AddRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue) + + // ObserveHTTPRequestDuration measures the duration of an HTTP request. + ObserveHTTPRequestDuration(ctx context.Context, duration time.Duration, attributes []attribute.KeyValue) + + // ObserveHTTPRequestSize measures the size of an HTTP request in bytes. + ObserveHTTPRequestSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue) + + // ObserveHTTPResponseSize measures the size of an HTTP response in bytes. + ObserveHTTPResponseSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue) + + // AddInflightRequests increments and decrements the number of inflight request being processed. + AddInflightRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue) +} diff --git a/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/version.go b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/version.go new file mode 100644 index 000000000..323e1a4c1 --- /dev/null +++ b/vendor/github.com/technologize/otel-go-contrib/otelginmetrics/version.go @@ -0,0 +1,11 @@ +package otelginmetrics + +// Version is the current release version of the gin instrumentation. +func Version() string { + return "1.0.0" +} + +// SemVersion is the semantic version to be supplied to tracer/meter creation. +func SemVersion() string { + return "semver:" + Version() +} |