Skip to content

Commit 5b6e0bd

Browse files
committed
Add note to readme regarding updating to v2 and update changelog
1 parent c1cb0ce commit 5b6e0bd

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

changelog.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,9 @@
22

33
## 1.0.0
44

5-
* Create first module version
5+
* Create first module version
6+
7+
## 2.0.0
8+
9+
* Update the event structure to the new format Sentry has adopted for their official SDKs
10+
* Add support for the new `/api/{project_id}/envelope` endpoint Sentry has adopted for sending events

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ Just drop into your modules folder or use the `box` cli to install
2828
box install sentry
2929
```
3030

31+
## Updating to Version 2
32+
33+
Version 2 of this module includes some potentially breaking changes in how the event data that is sent to Sentry is constructed. In version 2 the events match the up to date format that Sentry has adopted for their official SDKs. If you are not sending your events to the Sentry hosted service, but using a self-hosted Sentry instance, please be sure you are running an up to date version of the Sentry service before updating to version 2 of this module.
34+
35+
Additionally, Sentry has deprecated sending events to the `/api/{project_id}/store` endpoint in favor of a new `/api/{project_id}/envelope` endpoint (and a new structure for the body of the post requests). Again, if you self-host an older version of the Sentry service, sending events to the `store` endpoint might be your only option. There is a new module setting, `sentryEventEndpoint`, that defaults to `store`, but can be set to `envelope` to enable sending events to the modern endpoint.
36+
3137
## CFML App Installation
3238

3339
If your app uses neither ColdBox nor LogBox, you can still instantiate the `SentryService` and use it directly so long as you prep it with the settings it needs.

0 commit comments

Comments
 (0)