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

Introduction of libhoney.Client should be documented in changelog #55

Closed
BRMatt opened this issue Mar 28, 2019 · 5 comments
Closed

Introduction of libhoney.Client should be documented in changelog #55

BRMatt opened this issue Mar 28, 2019 · 5 comments

Comments

@BRMatt
Copy link
Contributor

BRMatt commented Mar 28, 2019

This commit changed beeline.Init() so that it doesn't call the global libhoney.Init. This broke some of our services that are using both libhoney events and beeline traces while they migrate to libhoney.

Please can you document this change in the changelog?

@maplebed
Copy link
Contributor

Yes! Thank you; that should have happened in the first place.

@maplebed
Copy link
Contributor

Erp. Updating that changelog felt awfully familiar... The changes are already pending in an existing not-yet-reviewed PR #52

I'll bump the review request and get it merged.

@maplebed
Copy link
Contributor

maplebed commented Apr 9, 2019

I updated the changelog in b76b6f0 but it occurs to me that perhaps some more text around the libhoney.Client change would be useful to help people understand the ramifications of the change. (As an example, the problem you ran in to would not be obvious from what's currently written there.)

Do you have any suggestions on the type of language that would be useful there? Maybe something like this?

This change means that the beeline no longer uses the global libhoney config. If you are setting specific configurations on the global libhoney and wish them to be used by the beeline, you will need to create a libhoney client with those changes and explicitly configure the beeline with that client.

@BRMatt
Copy link
Contributor Author

BRMatt commented Apr 9, 2019

That sounds like a great idea! It might be worth saying that this would affect folks who are manually calling libhoney.Init() in addition to beeline.Init(), as folks who didn't setup the library might not be sure how a "global libhoney config" relates to the code they have in front of them.

@JamieDanielson
Copy link
Contributor

Closing this as there has been no recent activity and it appears it was covered in changelog updates. Feel free to request a re-open if it’s still relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants