All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.
This project adheres to Semantic Versioning.
1.2.0 (2024-07-09)
- updated middleware.go (fd00708)
1.1.0 (2024-07-07)
- add filter function to skip tracing based on the request. (a064d40)
- add multiple filters in WithFilter option (3292e4d)
- add trace id to response header (c65058a)
- add WithPublicEndpoint & WithPublicEndpointFn option to config.go; (64f2d2d)
- added traceID on context (59aee53)
- adjust example for version 0.7 (be5af93)
- finish implement publicEndpointFn in middleware.go; (b70e4bf)
- remove http.target attribute based on https://github.com/open-telemetry/opentelemetry-go/blob/v1.14.0/semconv/internal/v2/http.go#L160-L165; adjust tests accordingly; (e88a9d7)
- renamed to trace-id (7b7af22)
- return 0.9.0 in Version(); (cbbec48)
- set library version to
0.7.0
; (10d8643) - update semconv to 1.17.0 (9172525)
- update semconv to v1.20, update example basic to go1.19,otel1.24,semconv1.20 (09acd4b)
- upgrade to go1.21 and otel 1.26 (fc85136)
- broken empty routes in chi/v5.0.8 (fc4a7b5)
- implement default trace-id in response header (38d0a62)
- implement the change request (b908ef0)
- issue on multiservice example (f5b4663)
- set the default of status code to 200 in case of no op in http handler; (cf20db3)
- update
X-Trace-ID
intoX-Trace-Id
since this is the common format (e.g X-AMZN-Trace-Id); update incorrect comment forWithTraceIDResponseHeader
option; (97501d1) - use correct instrumentation version value; (a2aab44)
- add filter function to skip tracing based on the request. (a064d40)
- add multiple filters in WithFilter option (3292e4d)
- add trace id to response header (c65058a)
- add WithPublicEndpoint & WithPublicEndpointFn option to config.go; (64f2d2d)
- added traceID on context (59aee53)
- adjust example for version 0.7 (be5af93)
- finish implement publicEndpointFn in middleware.go; (b70e4bf)
- remove http.target attribute based on https://github.com/open-telemetry/opentelemetry-go/blob/v1.14.0/semconv/internal/v2/http.go#L160-L165; adjust tests accordingly; (e88a9d7)
- renamed to trace-id (7b7af22)
- return 0.9.0 in Version(); (cbbec48)
- set library version to
0.7.0
; (10d8643) - update semconv to 1.17.0 (9172525)
- update semconv to v1.20, update example basic to go1.19,otel1.24,semconv1.20 (09acd4b)
- upgrade to go1.21 and otel 1.26 (fc85136)
- broken empty routes in chi/v5.0.8 (fc4a7b5)
- implement default trace-id in response header (38d0a62)
- implement the change request (b908ef0)
- issue on multiservice example (f5b4663)
- set the default of status code to 200 in case of no op in http handler; (cf20db3)
- update
X-Trace-ID
intoX-Trace-Id
since this is the common format (e.g X-AMZN-Trace-Id); update incorrect comment forWithTraceIDResponseHeader
option; (97501d1) - use correct instrumentation version value; (a2aab44)
1.1.0 (2024-07-07)
- renamed to trace-id (edd5dd9)
0.9.0 - 2024-07-06
WithFilter
option now support multiple filter functions, just like in otelmux. (#47)- Upgrade
go.opentelemetry.io/otel
,go.opentelemetry.io/otel/sdk
, &go.opentelemetry.io/otel/trace
tov1.28.0
. (#49) - Upgrade
github.com/go-chi/chi/v5
tov5.1.0
. (#49) - Set the go versions for testing in both
Makefile
&compatibility-test.yml
to1.21
&1.22
. (#49)
- Drop support for Go
<1.21
. (#49)
0.8.0 - 2024-04-29
This release is the last to support Go 1.19
. The next release will require at least Go 1.21
.
- Add
WithPublicEndpoint
&WithPublicEndpointFn
options. (#43)
- Upgrade to
v1.24.0
ofgo.opentelemetry.io/otel
. (#41) - Upgrade to
v1.20.0
ofgo.opentelemetry.io/otel/semconv
. (#41) - Adjust Go version for both
examples/basic
&examples/multi-services
to1.19
&go.opentelemetry.io/otel
tov1.24.0
. (#41) - Update otelhttp version to
0.49.0
since it is the version that uses otel1.24.0
internally, check here for details. (#42) - Set the go versions in compatibility-test.yml to 1.19, 1.20, & 1.21. (#42)
- Set the sampling strategy to always sample in test cases to avoid random error. (#42)
- Use
otlptrace
exporter instead ofjaeger
exporter inexamples/multi-services
. (#42)
- Remove the deprecated
jaeger
exporter fromexamples/multi-services
& useotlptrace
exporter instead. (#42) - Drop support for Go
<1.19
. (#41)
0.7.0 - 2024-04-22
This release is the last to support Go 1.18
. The next release will require at least Go 1.19
.
- Upgrade to
v1.14.0
ofgo.opentelemetry.io/otel
. (#38) - Upgrade to
v1.17.0
ofgo.opentelemetry.io/otel/semconv
. (#38) - Adjust Go version for both
examples/basic
&examples/multi-services
to1.18
&go.opentelemetry.io/otel
tov1.14.0
. (#38) - Change
http.server_name
attributes tonet.host.name
, this is because semconv is removing this attribute for http. (#38)
- Remove
http.target
attribute on implementation & tests based on this comment. (#39) - Drop support for Go
<1.18
. (#38)
0.6.0 - 2024-04-02
This release is the last to support Go 1.15
. The next release will require at least Go 1.18
.
- Add
WithTraceIDResponseHeader
option to enable adding trace id into response header. (#36) - Add multiple go versions test scripts for local and CI pipeline. (#29)
- Add compatibility testing for
ubuntu
,macos
andwindows
. (#32) - Add repo essentials docs. (#33)
- Upgrade to
v5.0.12
ofgo-chi/chi
. (#29) - Upgrade to
v1.10.0
ofgo.opentelemetry.io/otel
. (#29) - Upgrade to
v1.12.0
ofgo.opentelemetry.io/otel/semconv
. (#29) - Set the required go version for both
examples/basic
&examples/multi-services
to1.15
,go-chi/chi
tov5.0.12
, &go.opentelemetry.io/otel
tov1.10.0
(#35)
0.5.2 - 2024-03-25
- Fix empty status code. (#30)
- Return
http.StatusOK
(200) as a defaulthttp.status_code
span attribute. (#30)
0.5.1 - 2023-02-18
- Fix broken empty routes. (#18)
- Upgrade to
v5.0.8
ofgo-chi/chi
.
0.5.0 - 2022-10-02
- Add multi services example. (#9)
- Add
WithFilter()
option to ignore tracing in certain endpoints. (#11)
0.4.0 - 2022-02-22
- Add Option
WithRequestMethodInSpanName()
to handle vendor that do not include HTTP request method as mentioned in #6. (#7) - Refine description for
WithChiRoutes()
option to announce it is possible to override the span name in underlying handler with this option.
0.3.0 - 2022-01-18
- Fix both
docker-compose.yml
&Dockerfile
in the example. (#5)
- Add
WithChiRoutes()
option to make the middleware able to determine full route pattern on span creation. (#5) - Set all known span attributes on span creation rather than set them after request is being executed. (#5)
0.2.1 - 2022-01-08
- Add build example to CI pipeline. (#2)
- Use
ctx.RoutePattern()
to get span name, this is to strip out noisy wildcard pattern. (#1)
0.2.0 - 2021-10-18
- Set service name on tracer provider from code example.
- Update dependencies in go.mod
- Upgrade to
v1.0.1
ofgo.opentelemetry.io/otel
. - Upgrade to
v5.0.4
ofgo-chi/chi
. - Update latest test to use
otelmux
format.
- Remove
HTTPResponseContentLengthKey
- Remove
HTTPTargetKey
, since automatically set inHTTPServerAttributesFromHTTPRequest
0.1.0 - 2021-08-11
This is the first release of otelchi. It contains instrumentation for trace and depends on:
- otel =>
v1.0.0-RC2
- go-chi/chi =>
v5.0.3
- Instrumentation for trace.
- CI files.
- Example code for a basic usage.
- Apache-2.0 license.