Add Correlation ID support to client error + activity tracking records #338
Conversation
# Conflicts: # CHANGELOG.md # grails-app/controllers/io/xh/hoist/impl/XhController.groovy # grails-app/domain/io/xh/hoist/clienterror/ClientError.groovy # grails-app/domain/io/xh/hoist/track/TrackLog.groovy # grails-app/services/io/xh/hoist/clienterror/ClientErrorService.groovy
# Conflicts: # CHANGELOG.md
CHANGELOG.md
Outdated
| ### 🎁 New Features | ||
|
|
||
| * Added support for tracking Correlation ID's in Activity and Client Error logs. | ||
| Requires `hoist-react >= 67.0.0`. |
There was a problem hiding this comment.
I assume that we mean the feature requires hoist-react, not the overall hoist-core version - i.e. you can still take this core update even if you are not ready to take the react update. We should clarify, should be examples in this CL of that language
There was a problem hiding this comment.
We should also include example SQL to add the columns - see other examples in this file
| @@ -61,7 +61,7 @@ class ClientErrorService extends BaseService { | |||
| * @param appVersion - expected from client to ensure we record the version user's browser is actually running | |||
| * @param url - location where error occurred | |||
There was a problem hiding this comment.
doc string getting (more) out of date
| @@ -68,6 +70,7 @@ class TrackLog implements JSONFormat { | |||
| device: device, | |||
| userAgent: userAgent, | |||
| category: category, | |||
| correlationId: correlationId, | |||
There was a problem hiding this comment.
Tiny thing, but let's move this up after ID, as with ClientError. I always want some kind of recipe for more consistency here, don't think we really have one, but might as well add the new prop in the same place.
amcclain
changed the title
# Conflicts: # CHANGELOG.md
|
Noting for the record that we've discussed some other ways hoist-core could incorporate correlation IDs:
BUT - I think it is prudent to get a first cut out with the basic support we have here + the support in hoist-react, then see how they start to percolate through app code in practice and revisit these additional hoist-core features in the future. |
…tivity tracking