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.

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

Release v0.8.0 #44

Merged
merged 8 commits into from
Apr 29, 2024
98 changes: 72 additions & 26 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,31 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased]

## [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 ⚠️
Expand All @@ -16,15 +41,15 @@ This release is the last to support Go `1.18`. The next release will require at

### 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)
- 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)
- 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

Expand All @@ -34,33 +59,33 @@ This release is the last to support Go `1.15`. The next release will require at

### 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)
- 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)
- 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)
- Fix empty status code. ([#30])

### Changed

- Return `http.StatusOK` (200) as a default `http.status_code` span attribute. (#30)
- 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)
- Fix broken empty routes. ([#18])

### Changed

Expand All @@ -70,14 +95,14 @@ This release is the last to support Go `1.15`. The next release will require at

### Added

- Add multi services example. (#9)
- Add `WithFilter()` option to ignore tracing in certain endpoints. (#11)
- 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)
- 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
Expand All @@ -86,22 +111,22 @@ This release is the last to support Go `1.15`. The next release will require at

### Fixed

- Fix both `docker-compose.yml` & `Dockerfile` in the example. (#5)
- 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)
- 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)
- Add build example to CI pipeline. ([#2])

### Changed

- Use `ctx.RoutePattern()` to get span name, this is to strip out noisy wildcard pattern. (#1)
- Use `ctx.RoutePattern()` to get span name, this is to strip out noisy wildcard pattern. ([#1])

## [0.2.0] - 2021-10-18

Expand Down Expand Up @@ -136,7 +161,28 @@ It contains instrumentation for trace and depends on:
- Example code for a basic usage.
- Apache-2.0 license.

[Unreleased]: https://github.com/riandyrn/otelchi/compare/v0.7.0...HEAD
[#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.8.0...HEAD
[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
Expand Down
Loading