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

Merged
merged 2 commits into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 46 additions & 20 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,46 @@
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/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

---

## [2.3.1] - 2024-10-09

### Changed

- Use `opentelemetry_semantic_conventions` 1.x

---

## [2.3.0] - 2024-05-27

### Added

- Support custom metadata from integrators. Use `OpentelemetryAbsinthe.TelemetryMetadata` to add metadata to your context which will then be broadcast.
- Allow attaching to `[:absinthe, :subscription, :publish]` (both `:start` and `:stop`) given a `trace_subscription: true` config
- Support custom metadata from integrators. Use
`OpentelemetryAbsinthe.TelemetryMetadata` to add metadata to your context
which will then be broadcast.
- Allow attaching to `[:absinthe, :subscription, :publish]` (both `:start` and
`:stop`) given a `trace_subscription: true` config
- New `graphql.event.type` trace attribute, with value `operation` or `publish`

## [2.3.0-rc.0] - 2024-04-18

### Added

- Allow attaching to `[:absinthe, :subscription, :publish]` (both `:start` and `:stop`) given a `trace_subscription: true` config
- Allow attaching to `[:absinthe, :subscription, :publish]` (both `:start` and
`:stop`) given a `trace_subscription: true` config
- New `graphql.event.type` trace attribute, with value `operation` or `publish`

## [2.2.1] - 2024-02-21

### Changed

- Unpinned absinthe patch version in order to not downgrade it when this package is required
- Unpinned absinthe patch version in order to not downgrade it when this package
is required

## [2.2.0] - 2024-02-20

Expand All @@ -46,44 +60,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- absinthe is now a required dependency. The library failed to compile since version 2.0.0 with it being optional so this is not a breaking change.
- attribute keys are now atoms, which should offer minor performance improvements.
- loosened the telemetry version requirement from `~> 0.4 or ~> 1.0.0` to `~> 0.4 or ~> 1.0`
- absinthe is now a required dependency. The library failed to compile since
version 2.0.0 with it being optional so this is not a breaking change.
- attribute keys are now atoms, which should offer minor performance
improvements.
- loosened the telemetry version requirement from `~> 0.4 or ~> 1.0.0` to
`~> 0.4 or ~> 1.0`

## [2.0.0] - 2023-03-07

### Added

- new `trace_request_selections` option to enable tracing root level GraphQL selections, which will be stored under `graphql.request.selections`.
- new `trace_request_selections` option to enable tracing root level GraphQL
selections, which will be stored under `graphql.request.selections`.
- attribute `graphql.operation.name` was added.
- attribute `graphql.operation.type` was added.
- span_name can now be set to `:dynamic`, causing it to be set dynamically based on the operation type and name, as recommended by [opentelemetry](https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/instrumentation/graphql/).
- span_name can now be set to `:dynamic`, causing it to be set dynamically based
on the operation type and name, as recommended by
[opentelemetry](https://opentelemetry.io/docs/reference/specification/trace/semantic_conventions/instrumentation/graphql/).

### Changed

- BREAKING: `graphql.request.query` was renamed to `graphql.document`.
- BREAKING: the default value of span_name is now `:dynamic`
- BREAKING: opentelemetry_absinthe will no longer log sensitive information by default.
By default the graphql.request.variables, graphql.response.errors and graphql.response.result attributes will no longer be emited.
The previous behavior can be restored by setting the opentelemetry_absinthe configuration options.
- BREAKING: opentelemetry_absinthe will no longer log sensitive information by
default. By default the graphql.request.variables, graphql.response.errors and
graphql.response.result attributes will no longer be emited. The previous
behavior can be restored by setting the opentelemetry_absinthe configuration
options.

- `OpentelemetryAbsinthe.setup` can now optionally recieve the configuration. Previously `OpentelemetryAbsinthe.Instrumentation.setup` had to be used.
- `OpentelemetryAbsinthe.setup` can now optionally recieve the configuration.
Previously `OpentelemetryAbsinthe.Instrumentation.setup` had to be used.

### Deprecated

- setting the span name to a static string.

## [1.1.0] - 2022-09-21

### Changed

- opentelemetry_absinthe does not set opentelemetry-related Logger metadata anymore, because
The OpenTelemetry API/SDK itself [does that automatically since 1.1.0](https://github.com/open-telemetry/opentelemetry-erlang/pull/394).
If you're upgrading to opentelemetry_absinthe 1.1.0, it is therefore recommended to also upgrade to OpenTelemetry API 1.1.0
in order to keep the opentelemetry log metadata.

- opentelemetry_absinthe does not set opentelemetry-related Logger metadata
anymore, because The OpenTelemetry API/SDK itself
[does that automatically since 1.1.0](https://github.com/open-telemetry/opentelemetry-erlang/pull/394).
If you're upgrading to opentelemetry_absinthe 1.1.0, it is therefore
recommended to also upgrade to OpenTelemetry API 1.1.0 in order to keep the
opentelemetry log metadata.


[Unreleased]: https://github.com/primait/opentelemetry_absinthe/compare/2.3.0...HEAD
[Unreleased]: https://github.com/primait/opentelemetry_absinthe/compare/2.3.1...HEAD
[2.3.1]: https://github.com/primait/opentelemetry_absinthe/compare/2.3.0...2.3.1
[2.3.0]: https://github.com/primait/opentelemetry_absinthe/compare/2.3.0-rc.0...2.3.0
[2.3.0-rc.0]: https://github.com/primait/opentelemetry_absinthe/compare/2.2.1...2.3.0-rc.0
[2.2.0]: https://github.com/primait/opentelemetry_absinthe/compare/2.2.0...2.2.1
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule OpentelemetryAbsinthe.MixProject do
use Mix.Project

@source_url "https://github.com/primait/opentelemetry_absinthe"
@version "2.3.0"
@version "2.3.1"

def project do
[
Expand Down
Loading