Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(spans): adhere attribute name to otel semver #185

Merged
merged 8 commits into from
Dec 13, 2024
Merged

fix(spans): adhere attribute name to otel semver #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d641c90
fix(spans): adhere attribute name to otel semver
Strazz1337 Oct 12, 2024
7f78df4
chore: bump version to v1.4.6
Strazz1337 Oct 12, 2024
3c48333
Merge remote-tracking branch 'upstream/main' into fix-adhere-to-otel-…
Strazz1337 Dec 13, 2024
f94251c
refactor: use separate file for semantic conventions
Strazz1337 Dec 13, 2024
4b14514
Apply suggestions from code review
baywet Dec 13, 2024
3692bb2
chore: bumps patch version
baywet Dec 13, 2024
e1f0d35
fix: normalizes request header constant
baywet Dec 13, 2024
9cce1d8
fix: makes all constants private
baywet Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.4.7] - 2024-12-13

### Changed

- Updated HTTP span attributes to comply with updated OpenTelemetry semantic conventions. [#182](https://github.com/microsoft/kiota-http-go/issues/182)

## [1.4.6] - 2024-12-13

### Changed
Expand Down
322 changes: 161 additions & 161 deletions compression_handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,161 +1,161 @@
package nethttplibrary
import (
"bytes"
"compress/gzip"
"io"
"net/http"
"strings"
abstractions "github.com/microsoft/kiota-abstractions-go"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
)
// CompressionHandler represents a compression middleware
type CompressionHandler struct {
options CompressionOptions
}
// CompressionOptions is a configuration object for the CompressionHandler middleware
type CompressionOptions struct {
enableCompression bool
}
type compression interface {
abstractions.RequestOption
ShouldCompress() bool
}
var compressKey = abstractions.RequestOptionKey{Key: "CompressionHandler"}
// NewCompressionHandler creates an instance of a compression middleware
func NewCompressionHandler() *CompressionHandler {
options := NewCompressionOptions(true)
return NewCompressionHandlerWithOptions(options)
}
// NewCompressionHandlerWithOptions creates an instance of the compression middleware with
// specified configurations.
func NewCompressionHandlerWithOptions(option CompressionOptions) *CompressionHandler {
return &CompressionHandler{options: option}
}
// NewCompressionOptions creates a configuration object for the CompressionHandler
func NewCompressionOptions(enableCompression bool) CompressionOptions {
return CompressionOptions{enableCompression: enableCompression}
}
// GetKey returns CompressionOptions unique name in context object
func (o CompressionOptions) GetKey() abstractions.RequestOptionKey {
return compressKey
}
// ShouldCompress reads compression setting form CompressionOptions
func (o CompressionOptions) ShouldCompress() bool {
return o.enableCompression
}
// Intercept is invoked by the middleware pipeline to either move the request/response
// to the next middleware in the pipeline
func (c *CompressionHandler) Intercept(pipeline Pipeline, middlewareIndex int, req *http.Request) (*http.Response, error) {
reqOption, ok := req.Context().Value(compressKey).(compression)
if !ok {
reqOption = c.options
}
obsOptions := GetObservabilityOptionsFromRequest(req)
ctx := req.Context()
var span trace.Span
if obsOptions != nil {
ctx, span = otel.GetTracerProvider().Tracer(obsOptions.GetTracerInstrumentationName()).Start(ctx, "CompressionHandler_Intercept")
span.SetAttributes(attribute.Bool("com.microsoft.kiota.handler.compression.enable", true))
defer span.End()
req = req.WithContext(ctx)
}
if !reqOption.ShouldCompress() || contentRangeBytesIsPresent(req.Header) || contentEncodingIsPresent(req.Header) || req.Body == nil {
return pipeline.Next(req, middlewareIndex)
}
if span != nil {
span.SetAttributes(attribute.Bool("http.request_body_compressed", true))
}
unCompressedBody, err := io.ReadAll(req.Body)
unCompressedContentLength := req.ContentLength
if err != nil {
if span != nil {
span.RecordError(err)
}
return nil, err
}
compressedBody, size, err := compressReqBody(unCompressedBody)
if err != nil {
if span != nil {
span.RecordError(err)
}
return nil, err
}
req.Header.Set("Content-Encoding", "gzip")
req.Body = compressedBody
req.ContentLength = int64(size)
if span != nil {
span.SetAttributes(attribute.Int64("http.request_content_length", req.ContentLength))
}
// Sending request with compressed body
resp, err := pipeline.Next(req, middlewareIndex)
if err != nil {
return nil, err
}
// If response has status 415 retry request with uncompressed body
if resp.StatusCode == 415 {
delete(req.Header, "Content-Encoding")
req.Body = io.NopCloser(bytes.NewBuffer(unCompressedBody))
req.ContentLength = unCompressedContentLength
if span != nil {
span.SetAttributes(attribute.Int64("http.request_content_length", req.ContentLength),
attribute.Int("http.request_content_length", 415))
}
return pipeline.Next(req, middlewareIndex)
}
return resp, nil
}
func contentRangeBytesIsPresent(header http.Header) bool {
contentRanges, _ := header["Content-Range"]
for _, contentRange := range contentRanges {
if strings.Contains(strings.ToLower(contentRange), "bytes") {
return true
}
}
return false
}
func contentEncodingIsPresent(header http.Header) bool {
_, ok := header["Content-Encoding"]
return ok
}
func compressReqBody(reqBody []byte) (io.ReadSeekCloser, int, error) {
var buffer bytes.Buffer
gzipWriter := gzip.NewWriter(&buffer)
if _, err := gzipWriter.Write(reqBody); err != nil {
return nil, 0, err
}
if err := gzipWriter.Close(); err != nil {
return nil, 0, err
}
reader := bytes.NewReader(buffer.Bytes())
return NopCloser(reader), buffer.Len(), nil
}
package nethttplibrary

import (
"bytes"
"compress/gzip"
"io"
"net/http"
"strings"

abstractions "github.com/microsoft/kiota-abstractions-go"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
)

// CompressionHandler represents a compression middleware
type CompressionHandler struct {
options CompressionOptions
}

// CompressionOptions is a configuration object for the CompressionHandler middleware
type CompressionOptions struct {
enableCompression bool
}

type compression interface {
abstractions.RequestOption
ShouldCompress() bool
}

var compressKey = abstractions.RequestOptionKey{Key: "CompressionHandler"}

// NewCompressionHandler creates an instance of a compression middleware
func NewCompressionHandler() *CompressionHandler {
options := NewCompressionOptions(true)
return NewCompressionHandlerWithOptions(options)
}

// NewCompressionHandlerWithOptions creates an instance of the compression middleware with
// specified configurations.
func NewCompressionHandlerWithOptions(option CompressionOptions) *CompressionHandler {
return &CompressionHandler{options: option}
}

// NewCompressionOptions creates a configuration object for the CompressionHandler
func NewCompressionOptions(enableCompression bool) CompressionOptions {
return CompressionOptions{enableCompression: enableCompression}
}

// GetKey returns CompressionOptions unique name in context object
func (o CompressionOptions) GetKey() abstractions.RequestOptionKey {
return compressKey
}

// ShouldCompress reads compression setting form CompressionOptions
func (o CompressionOptions) ShouldCompress() bool {
return o.enableCompression
}

// Intercept is invoked by the middleware pipeline to either move the request/response
// to the next middleware in the pipeline
func (c *CompressionHandler) Intercept(pipeline Pipeline, middlewareIndex int, req *http.Request) (*http.Response, error) {
reqOption, ok := req.Context().Value(compressKey).(compression)
if !ok {
reqOption = c.options
}

obsOptions := GetObservabilityOptionsFromRequest(req)
ctx := req.Context()
var span trace.Span
if obsOptions != nil {
ctx, span = otel.GetTracerProvider().Tracer(obsOptions.GetTracerInstrumentationName()).Start(ctx, "CompressionHandler_Intercept")
span.SetAttributes(attribute.Bool("com.microsoft.kiota.handler.compression.enable", true))
defer span.End()
req = req.WithContext(ctx)
}

if !reqOption.ShouldCompress() || contentRangeBytesIsPresent(req.Header) || contentEncodingIsPresent(req.Header) || req.Body == nil {
return pipeline.Next(req, middlewareIndex)
}
if span != nil {
span.SetAttributes(attribute.Bool("http.request_body_compressed", true))
}

unCompressedBody, err := io.ReadAll(req.Body)
unCompressedContentLength := req.ContentLength
if err != nil {
if span != nil {
span.RecordError(err)
}
return nil, err
}

compressedBody, size, err := compressReqBody(unCompressedBody)
if err != nil {
if span != nil {
span.RecordError(err)
}
return nil, err
}

req.Header.Set("Content-Encoding", "gzip")
req.Body = compressedBody
req.ContentLength = int64(size)

if span != nil {
span.SetAttributes(httpRequestBodySizeAttribute.Int(int(req.ContentLength)))
}

// Sending request with compressed body
resp, err := pipeline.Next(req, middlewareIndex)
if err != nil {
return nil, err
}

// If response has status 415 retry request with uncompressed body
if resp.StatusCode == 415 {
delete(req.Header, "Content-Encoding")
req.Body = io.NopCloser(bytes.NewBuffer(unCompressedBody))
req.ContentLength = unCompressedContentLength

if span != nil {
span.SetAttributes(httpRequestBodySizeAttribute.Int(int(req.ContentLength)),
httpResponseStatusCodeAttribute.Int(415))
}

return pipeline.Next(req, middlewareIndex)
}

return resp, nil
}

func contentRangeBytesIsPresent(header http.Header) bool {
contentRanges, _ := header["Content-Range"]
for _, contentRange := range contentRanges {
if strings.Contains(strings.ToLower(contentRange), "bytes") {
return true
}
}
return false
}

func contentEncodingIsPresent(header http.Header) bool {
_, ok := header["Content-Encoding"]
return ok
}

func compressReqBody(reqBody []byte) (io.ReadSeekCloser, int, error) {
var buffer bytes.Buffer
gzipWriter := gzip.NewWriter(&buffer)
if _, err := gzipWriter.Write(reqBody); err != nil {
return nil, 0, err
}

if err := gzipWriter.Close(); err != nil {
return nil, 0, err
}

reader := bytes.NewReader(buffer.Bytes())
return NopCloser(reader), buffer.Len(), nil
}
Loading
Loading