-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[error tracking] Add ticketing systems integration doc #33803
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
Conversation
Preview links (active after the
|
47ef237 to
8786e0b
Compare
iadjivon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello,
Thanks for this PR! The content is great, my comments and suggestions fall mostly on stylistic changes and best practices. In addition to those comments, please also review:
-
The images for PII (including your name), some images may have to be retaken. We often avoid including the left navigation in the images and I sometimes use the dev tools to remove some PII. Let me know if you'd like support with that.
-
A number of sentences seem to break off and start a new line mid-way through. I added a comment for a few of them but may not have caught all. Please take a look at these as well and let me know if you have any questions or need support with it.
Thanks so much!
60db97f to
1f23295
Compare
iadjivon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello, thanks for these changes! Just called out a couple of small items after which we should be all set to approve.
One note that I re-opened a threat in the Case Management file in the Setup section where you mentioned adding a paragraph on creating Jira.
| Follow [these steps][7] to set up the Jira integration for Datadog. | ||
|
|
||
| <div class="alert alert-info">Ticket creation from an Error Tracking issue is available for Jira Cloud and Data Center. Dual-sync between Jira and Error Tracking is only available for Jira Cloud.</div> | ||
|
|
||
| You need the following [permissions][1] to use the Jira integration for Error Tracking: | ||
|
|
||
| - Error Tracking Read | ||
| - Error Tracking Issue Write | ||
| - Cases Read | ||
| - Cases Write |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| Follow [these steps][7] to set up the Jira integration for Datadog. | |
| <div class="alert alert-info">Ticket creation from an Error Tracking issue is available for Jira Cloud and Data Center. Dual-sync between Jira and Error Tracking is only available for Jira Cloud.</div> | |
| You need the following [permissions][1] to use the Jira integration for Error Tracking: | |
| - Error Tracking Read | |
| - Error Tracking Issue Write | |
| - Cases Read | |
| - Cases Write | |
| The following items are required for integrating Jira with Error Tracking: | |
| 1. Follow [these steps][7] to set up the Jira integration for Datadog. | |
| <div class="alert alert-info">Ticket creation from an Error Tracking issue is available for Jira Cloud and Data Center. Dual-sync between Jira and Error Tracking is only available for Jira Cloud.</div> | |
| 2. Add the following [permissions][1] to use the Jira integration for Error Tracking: | |
| - Error Tracking Read | |
| - Error Tracking Issue Write | |
| - Cases Read | |
| - Cases Write |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me, "Add the following permissions" doesn't really make sense as these are permissions granted to the user that wishes to use the integration, by an admin of their org. If it's OK with you, I think the kind of "passive" wording used elsewhere in the doc (e.g. https://docs.datadoghq.com/tracing/live_debugger/#permissions) makes more sense. Happy to add the link to RBAC as they did, if it helps clarify our requirements!
For more information about roles and how to assign roles to users, see [Role Based Access Control](https://docs.datadoghq.com/account_management/rbac/permissions#apm).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I see, thanks for this clarification! In that case what you currently have works fine. Adding that sentence and a link to RBAC would be great also! Thanks
b2e1ec9 to
6c32770
Compare
6c32770 to
aee0952
Compare
iadjivon
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Ca-Jou, thanks for your patience as we review this PR. This is approved. Let me know if you have any questions.
Co-authored-by: Ida Adjivon <[email protected]>
Co-authored-by: Ida Adjivon <[email protected]>
Co-authored-by: Ida Adjivon <[email protected]>
df08489 to
d5f46d6
Compare

What does this PR do? What is the motivation?
Add documentation about Error Tracking's new ticketing systems (Jira and Case Management) integration.
These features are in preview now, and should be GA by the end of the month.
Merge instructions
Merge readiness: