Курнат Андрей
291 lines
10 KiB
Markdown
291 lines
10 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
|
|
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
## [0.12.2] - 2025-09-02
|
|
|
|
### Fixed
|
|
|
|
- Use TracerProvider from request context when available ([#92])
|
|
- Fix high-cardinality metrics and allows user control attributes each metric record ([#95])
|
|
|
|
## [0.12.1] - 2025-02-12
|
|
|
|
### Fixed
|
|
|
|
- Fix superfluous header writer ([#89])
|
|
|
|
## [0.12.0] - 2025-01-18
|
|
|
|
### Changed
|
|
|
|
- Upgrade `go.opentelemetry.io/otel`, `go.opentelemetry.io/otel/sdk`, & `go.opentelemetry.io/otel/trace` to `v1.34.0`. ([#87])
|
|
- Upgrade `go.opentelemetry.io/otel/metric` to `v1.34.0`. ([#87])
|
|
- Set the metric version to be the same as middleware version which is `v0.12.0` to make it easy for maintainer of this repo to maintain the versioning. ([#88])
|
|
|
|
## [0.11.0] - 2024-11-27
|
|
|
|
### Added
|
|
|
|
- Add metric package as middleware `go-chi/chi`, support `request_duration_millis`, `requests_inflight`, and `response_size_bytes` metric. Using `go.opentelemetry.io/otel/metric` which the version is `v1.32.0`. ([#69])
|
|
|
|
### Changed
|
|
|
|
- Upgrade `go.opentelemetry.io/otel`, `go.opentelemetry.io/otel/sdk`, & `go.opentelemetry.io/otel/trace` to `v1.32.0`. ([#74])
|
|
|
|
## [0.10.1] - 2024-10-27
|
|
|
|
### Changed
|
|
|
|
- Upgrade `go.opentelemetry.io/otel`, `go.opentelemetry.io/otel/sdk`, & `go.opentelemetry.io/otel/trace` to `v1.31.0`. ([#70])
|
|
|
|
### Fixed
|
|
|
|
- Span for websocket connection now won't be marked as error span. ([#67])
|
|
|
|
## [0.10.0] - 2024-09-17
|
|
|
|
### Added
|
|
|
|
- Add `WithTraceResponseHeaders` option to include trace information in response headers, this option replaces the deprecated `WithTraceIDResponseHeader` option. ([#62])
|
|
|
|
### Changed
|
|
|
|
- Upgrade `go.opentelemetry.io/otel`, `go.opentelemetry.io/otel/sdk`, & `go.opentelemetry.io/otel/trace` to `v1.30.0`. ([#64])
|
|
- Set the go versions for testing in both `Makefile` & `compatibility-test.yml` to `1.22` & `1.23`. ([#64])
|
|
|
|
### Fixed
|
|
|
|
- Fix Gobrew installation in CI pipeline. ([#63])
|
|
|
|
### Removed
|
|
|
|
- Drop support for Go 1.21. ([#64])
|
|
- Deprecated `WithTraceIDResponseHeader` option, use `WithTraceResponseHeaders` instead. ([#62])
|
|
|
|
## [0.9.0] - 2024-07-06
|
|
|
|
### Changed
|
|
|
|
- `WithFilter` option now support multiple filter functions, just like in [otelmux](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/v1.24.0/instrumentation/github.com/gorilla/mux/otelmux/config.go#L106-L110). ([#47])
|
|
- Upgrade `go.opentelemetry.io/otel`, `go.opentelemetry.io/otel/sdk`, & `go.opentelemetry.io/otel/trace` to `v1.28.0`. ([#49])
|
|
- Upgrade `github.com/go-chi/chi/v5` to `v5.1.0`. ([#49])
|
|
- Set the go versions for testing in both `Makefile` & `compatibility-test.yml` to `1.21` & `1.22`. ([#49])
|
|
|
|
### Removed
|
|
|
|
- Drop support for Go `<1.21`. ([#49])
|
|
|
|
## [0.8.0] - 2024-04-29
|
|
|
|
### ⚠️ Notice ⚠️
|
|
|
|
This release is the last to support Go `1.19`. The next release will require at least Go `1.21`.
|
|
|
|
### Added
|
|
|
|
- Add `WithPublicEndpoint` & `WithPublicEndpointFn` options. ([#43])
|
|
|
|
### Changed
|
|
|
|
- Upgrade to `v1.24.0` of `go.opentelemetry.io/otel`. ([#41])
|
|
- Upgrade to `v1.20.0` of `go.opentelemetry.io/otel/semconv`. ([#41])
|
|
- Adjust Go version for both `examples/basic` & `examples/multi-services` to `1.19` & `go.opentelemetry.io/otel` to `v1.24.0`. ([#41])
|
|
- Update otelhttp version to `0.49.0` since it is the version that uses otel `1.24.0` internally, check [here](https://github.com/open-telemetry/opentelemetry-go-contrib/blob/v1.24.0/instrumentation/net/http/otelhttp/go.mod#L8) 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 of `jaeger` exporter in `examples/multi-services`. ([#42])
|
|
|
|
### Removed
|
|
|
|
- Remove the deprecated `jaeger` exporter from `examples/multi-services` & use `otlptrace` exporter instead. ([#42])
|
|
- Drop support for Go `<1.19`. ([#41])
|
|
|
|
## [0.7.0] - 2024-04-22
|
|
|
|
### ⚠️ Notice ⚠️
|
|
|
|
This release is the last to support Go `1.18`. The next release will require at least Go `1.19`.
|
|
|
|
### Changed
|
|
|
|
- Upgrade to `v1.14.0` of `go.opentelemetry.io/otel`. ([#38])
|
|
- Upgrade to `v1.17.0` of `go.opentelemetry.io/otel/semconv`. ([#38])
|
|
- Adjust Go version for both `examples/basic` & `examples/multi-services` to `1.18` & `go.opentelemetry.io/otel` to `v1.14.0`. ([#38])
|
|
- Change `http.server_name` attributes to `net.host.name`, this is because semconv is removing this attribute for http. ([#38])
|
|
|
|
### Removed
|
|
|
|
- Remove `http.target` attribute on implementation & tests based on [this comment](https://github.com/open-telemetry/opentelemetry-go/blob/v1.17.0/semconv/internal/v2/http.go#L160-L165). ([#39])
|
|
- Drop support for Go `<1.18`. ([#38])
|
|
|
|
## [0.6.0] - 2024-04-02
|
|
|
|
### ⚠️ Notice ⚠️
|
|
|
|
This release is the last to support Go `1.15`. The next release will require at least Go `1.18`.
|
|
|
|
### Added
|
|
|
|
- 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` and `windows`. ([#32])
|
|
- Add repo essentials docs. ([#33])
|
|
|
|
### Changed
|
|
|
|
- Upgrade to `v5.0.12` of `go-chi/chi`. ([#29])
|
|
- Upgrade to `v1.10.0` of `go.opentelemetry.io/otel`. ([#29])
|
|
- Upgrade to `v1.12.0` of `go.opentelemetry.io/otel/semconv`. ([#29])
|
|
- Set the required go version for both `examples/basic` & `examples/multi-services` to `1.15`, `go-chi/chi` to `v5.0.12`, & `go.opentelemetry.io/otel` to `v1.10.0` ([#35])
|
|
|
|
## [0.5.2] - 2024-03-25
|
|
|
|
### Fixed
|
|
|
|
- Fix empty status code. ([#30])
|
|
|
|
### Changed
|
|
|
|
- Return `http.StatusOK` (200) as a default `http.status_code` span attribute. ([#30])
|
|
|
|
## [0.5.1] - 2023-02-18
|
|
|
|
### Fixed
|
|
|
|
- Fix broken empty routes. ([#18])
|
|
|
|
### Changed
|
|
|
|
- Upgrade to `v5.0.8` of `go-chi/chi`.
|
|
|
|
## [0.5.0] - 2022-10-02
|
|
|
|
### Added
|
|
|
|
- Add multi services example. ([#9])
|
|
- Add `WithFilter()` option to ignore tracing in certain endpoints. ([#11])
|
|
|
|
## [0.4.0] - 2022-02-22
|
|
|
|
### Added
|
|
|
|
- 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.
|
|
|
|
### Changed
|
|
|
|
## [0.3.0] - 2022-01-18
|
|
|
|
### Fixed
|
|
|
|
- Fix both `docker-compose.yml` & `Dockerfile` in the example. ([#5])
|
|
|
|
### Added
|
|
|
|
- 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
|
|
|
|
### Added
|
|
|
|
- Add build example to CI pipeline. ([#2])
|
|
|
|
### Changed
|
|
|
|
- Use `ctx.RoutePattern()` to get span name, this is to strip out noisy wildcard pattern. ([#1])
|
|
|
|
## [0.2.0] - 2021-10-18
|
|
|
|
### Added
|
|
|
|
- Set service name on tracer provider from code example.
|
|
|
|
### Changed
|
|
|
|
- Update dependencies in go.mod
|
|
- Upgrade to `v1.0.1` of `go.opentelemetry.io/otel`.
|
|
- Upgrade to `v5.0.4` of `go-chi/chi`.
|
|
- Update latest test to use `otelmux` format.
|
|
|
|
### Removed
|
|
|
|
- Remove `HTTPResponseContentLengthKey`
|
|
- Remove `HTTPTargetKey`, since automatically set in `HTTPServerAttributesFromHTTPRequest`
|
|
|
|
## [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`
|
|
|
|
### Added
|
|
|
|
- Instrumentation for trace.
|
|
- CI files.
|
|
- Example code for a basic usage.
|
|
- Apache-2.0 license.
|
|
|
|
[#95]: https://github.com/riandyrn/otelchi/pull/95
|
|
[#92]: https://github.com/riandyrn/otelchi/pull/92
|
|
[#89]: https://github.com/riandyrn/otelchi/pull/89
|
|
[#88]: https://github.com/riandyrn/otelchi/pull/88
|
|
[#87]: https://github.com/riandyrn/otelchi/pull/87
|
|
[#74]: https://github.com/riandyrn/otelchi/pull/74
|
|
[#70]: https://github.com/riandyrn/otelchi/pull/70
|
|
[#69]: https://github.com/riandyrn/otelchi/pull/69
|
|
[#67]: https://github.com/riandyrn/otelchi/pull/67
|
|
[#64]: https://github.com/riandyrn/otelchi/pull/64
|
|
[#63]: https://github.com/riandyrn/otelchi/pull/63
|
|
[#62]: https://github.com/riandyrn/otelchi/pull/62
|
|
[#49]: https://github.com/riandyrn/otelchi/pull/49
|
|
[#47]: https://github.com/riandyrn/otelchi/pull/47
|
|
[#43]: https://github.com/riandyrn/otelchi/pull/43
|
|
[#42]: https://github.com/riandyrn/otelchi/pull/42
|
|
[#41]: https://github.com/riandyrn/otelchi/pull/41
|
|
[#39]: https://github.com/riandyrn/otelchi/pull/39
|
|
[#38]: https://github.com/riandyrn/otelchi/pull/38
|
|
[#36]: https://github.com/riandyrn/otelchi/pull/36
|
|
[#35]: https://github.com/riandyrn/otelchi/pull/35
|
|
[#33]: https://github.com/riandyrn/otelchi/pull/33
|
|
[#32]: https://github.com/riandyrn/otelchi/pull/32
|
|
[#30]: https://github.com/riandyrn/otelchi/pull/30
|
|
[#29]: https://github.com/riandyrn/otelchi/pull/29
|
|
[#18]: https://github.com/riandyrn/otelchi/pull/18
|
|
[#11]: https://github.com/riandyrn/otelchi/pull/11
|
|
[#9]: https://github.com/riandyrn/otelchi/pull/9
|
|
[#7]: https://github.com/riandyrn/otelchi/pull/7
|
|
[#6]: https://github.com/riandyrn/otelchi/pull/6
|
|
[#5]: https://github.com/riandyrn/otelchi/pull/5
|
|
[#2]: https://github.com/riandyrn/otelchi/pull/2
|
|
[#1]: https://github.com/riandyrn/otelchi/pull/1
|
|
|
|
[Unreleased]: https://github.com/riandyrn/otelchi/compare/v0.12.2...HEAD
|
|
[0.12.2]: https://github.com/riandyrn/otelchi/releases/tag/v0.12.2
|
|
[0.12.1]: https://github.com/riandyrn/otelchi/releases/tag/v0.12.1
|
|
[0.12.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.12.0
|
|
[0.11.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.11.0
|
|
[0.10.1]: https://github.com/riandyrn/otelchi/releases/tag/v0.10.1
|
|
[0.10.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.10.0
|
|
[0.9.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.9.0
|
|
[0.8.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.8.0
|
|
[0.7.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.7.0
|
|
[0.6.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.6.0
|
|
[0.5.2]: https://github.com/riandyrn/otelchi/releases/tag/v0.5.2
|
|
[0.5.1]: https://github.com/riandyrn/otelchi/releases/tag/v0.5.1
|
|
[0.5.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.5.0
|
|
[0.4.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.4.0
|
|
[0.3.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.3.0
|
|
[0.2.1]: https://github.com/riandyrn/otelchi/releases/tag/v0.2.1
|
|
[0.2.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.2.0
|
|
[0.1.0]: https://github.com/riandyrn/otelchi/releases/tag/v0.1.0
|