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

maint: Rename AutoInstrumentations package #327

Merged
merged 1 commit into from
Dec 14, 2022

Conversation

MikeGoldsmith
Copy link
Contributor

Which problem is this PR solving?

The AutoInstrumentations package doesn't accurately describe what the package actually does. It wires up some common instrumentation packages automatically for you, it does not have anything to do with auto instrumentation.

This PR renames the package to be more clear on what it does.

Short description of the changes

  • Rename Honeycomb.OpenTelemetry.AutoInstrumentations directory to Honeycomb.OpenTelemetry.CommonInstrumentations
  • Rename csproj and update internals to use CommonInstrumentations
  • Update AddAutoInstrumentations with AddCommonInstrumentations

@MikeGoldsmith MikeGoldsmith added the type: maintenance The necessary chores to keep the dust off. label Nov 30, 2022
@MikeGoldsmith MikeGoldsmith requested a review from a team November 30, 2022 15:21
@MikeGoldsmith MikeGoldsmith self-assigned this Nov 30, 2022
Copy link
Member

@cartermp cartermp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'tis a good alternative name!

Will also need docs and in-product (I think?) updates.

@MikeGoldsmith
Copy link
Contributor Author

Yeah, docs will need to be updated too. That can be done once we release this new package.

Copy link
Member

@cartermp cartermp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving as-is, with recognition that this does represent a breaking change for users, so we'll need to carefully roll out the package deprecation, change, and docs/product updates.

@MikeGoldsmith MikeGoldsmith added version: bump minor A PR that adds behavior, but is backwards-compatible. breaking-change Prefer 'version: bump major', but use this for breaking changes that don't bump major. labels Dec 14, 2022
@MikeGoldsmith MikeGoldsmith merged commit bb99760 into main Dec 14, 2022
@MikeGoldsmith MikeGoldsmith deleted the mike/rename-auto-instr-package branch December 14, 2022 19:25
@vreynolds
Copy link
Contributor

waiting to bump upstream OTel before releasing this

This was referenced Feb 27, 2023
JamieDanielson added a commit that referenced this pull request Mar 3, 2023
## Which problem is this PR solving?

- release of new main package, including dependency updates and method
changes from OTel v1.4.0
- release of new instrumentation package, including name change

## Short description of the changes

- add changelog entries.
- We renamed `AutoInstrumentations` to `CommonInstrumentations`; see
#327 for more details.
- OTel changed to `AddOpenTelemetry().WithTracing` and
`AddOpenTelemetry().WithMetrics`; see #334 for more details.
  - Update versions of main package from 1.2.1 to 1.3.0
- Update versions of instrumentation packages from 0.26.1-beta to
0.27.0-beta
- Update releasing notes with extra details for clarity


Once the release is out, docs updates can be merged in for public docs
and in-app onboarding (see #339 )
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Prefer 'version: bump major', but use this for breaking changes that don't bump major. type: maintenance The necessary chores to keep the dust off. version: bump minor A PR that adds behavior, but is backwards-compatible.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants