-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[SEC-31367] Document Ticket Creation Rules for Automation Pipelines #36851
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
Changes from all commits
c05da01
e397601
d5a6740
41daee2
2e0841a
db49ca6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| title: Ticket Creation Rules | ||
| site_support_id: case_management | ||
| products: | ||
| - name: Cloud Security | ||
| url: /security/cloud_security_management/ | ||
| icon: cloud-security-management | ||
| - name: Code Security | ||
| url: /security/code_security/ | ||
| icon: security-code-security | ||
| - name: App and API Protection | ||
| url: /security/application_security/ | ||
| icon: app-sec | ||
| further_reading: | ||
| - link: "/security/automation_pipelines" | ||
| tag: "Documentation" | ||
| text: "Automation Pipelines" | ||
| - link: "/security/ticketing_integrations" | ||
| tag: "Documentation" | ||
| text: "Ticketing Integrations" | ||
| - link: "/incident_response/case_management" | ||
| tag: "Documentation" | ||
| text: "Case Management" | ||
| --- | ||
|
|
||
| {{< product-availability >}} | ||
|
|
||
| Configure ticket creation rules to automatically create tickets in Jira or Case Management when new findings are discovered. This approach tracks security issues in your existing engineering workflows without manual triage, helping teams respond quickly to new threats at scale. For more information about ticketing integrations with security findings, see [Ticketing Integrations][3]. | ||
|
|
||
| ## Create a ticket creation rule | ||
|
|
||
| 1. In Datadog, go to **Security** > **Settings** > [Findings Automation][2]. Click **Add a New Rule**, then select **Create Ticket**. The Create a New Rule page opens. | ||
| 1. Under **Rule name**, enter a descriptive name for the rule; for example, "Critical vulnerabilities for engineering team". | ||
| 1. Add your rule criteria into the following fields: | ||
| - **Any of these types**: The types of findings that the rule should check for. Available types include: | ||
| - Runtime Code Vulnerability | ||
| - Static Code Vulnerability | ||
| - Library Vulnerability | ||
| - Secret | ||
| - Infrastructure as Code | ||
| - Container Image Vulnerability | ||
| - Host Vulnerability | ||
| - Misconfiguration | ||
| - Attack Path | ||
| - Identity Risk | ||
| - API Security | ||
| - **Any of these tags or attributes**: The resource tags or attributes that must match for the rule to apply. | ||
| 1. To add severity criteria to the rule, click **Add Severity**. | ||
| 1. Select the ticketing system and configure the ticket destination: | ||
| - **Jira** | ||
| - **Jira Account**: Select the Atlassian instance to use. | ||
| - **Space**: Select the Jira project. Verify that this space is added to the [Jira Webhook][5]. | ||
| - **Ticket Type**: Select the type of Jira issue to create, for example, **Task**. | ||
| - **Assignee** (optional): Specify a user to assign automatically created tickets to. | ||
| - To add more fields to the Jira ticket Datadog creates, use **Add Optional Field**. | ||
| - Expand **Data Sync Settings** to review or update the linked Case Management project and bidirectional sync configuration. | ||
| - **Case Management** | ||
| - **Case Management Project**: Select an existing Case Management project, or create one. | ||
| - **Assignee** (optional): Specify a user to assign automatically created cases to. | ||
| 1. Under **Rate limit**, enter the [maximum number of tickets](#daily-ticket-limit) this rule can create per UTC day. | ||
| 1. To test the rule before saving, click **Test Rule**, select a matching finding, and click **Run Test**. After the test completes, you can view the created ticket or detach the test ticket from the finding. | ||
| 1. Click **Save**. The rule applies to new findings only. It can take up to a few minutes after a finding is detected to create the corresponding ticket. | ||
|
|
||
| **Note**: Ticket creation rules only create tickets for new findings. Datadog does not create retroactive tickets for existing findings when you create a rule. | ||
|
|
||
| ## Identify automatically created tickets | ||
|
|
||
| {{< img src="security/automation_pipelines/ticket_creation_lightning_indicator.png" alt="Case Management ticket popup showing a case created by an Automation Rule, indicated with a lightning bolt icon, and a link to view all findings with tickets that were created from the same rule" style="width:60%;" >}} | ||
|
|
||
| Tickets created by a rule are marked with a lightning bolt indicator in the findings side panel and explorer views. Hovering over the indicator shows the automation rule responsible for the ticket and provides a link to the rule. | ||
|
|
||
| ## Rule matching order | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you wanted to, I think you could put these sections as subsections in the intro. I think it's helpful for users when they're deciding if they want to use a feature to get the nuance of how it works, and it helps if they can expect conceptual information to appear in one place in the doc. It's not terrible to have it at the end, but it does feel a little more tacked on than the "this is what this thing does!" expectation users already have about overviews.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for the suggestion, I tried restructuring with those subsections in the intro, but I'm not fully convinced it works well. Those are fairly fine-grained implementation details that most users won't need to read before getting started. The other automation pipeline pages also follow the pattern of putting procedural steps first, which keeps things consistent. I've also kept a link from the rate limit step in the creation flow to the dedicated section, so users who need the detail can jump to it. Happy to revisit if you feel strongly, but I'd lean toward keeping the current structure. |
||
|
|
||
| When Datadog identifies a finding, it evaluates the finding against your sequence of ticket creation rules. Starting with the first rule, if there's a match, Datadog creates a ticket using that rule's configuration and stops evaluating further. If no match occurs, Datadog moves to the next rule. This process continues until a match is found or all rules are checked without a match. | ||
|
|
||
| ## Daily ticket limit | ||
|
|
||
| Each rule has a configurable daily ticket limit that resets at midnight UTC. When the limit is reached, Datadog creates one final ticket in the same project explaining that the rule hit its daily limit, then stops creating tickets for the remainder of that day. Findings that exceed the limit are not retroactively ticketed when the limit resets, but you can create tickets for them manually. | ||
|
|
||
| ## Broken rules | ||
|
|
||
| If a project configuration error prevents ticket creation—for example, if the connected Jira project is no longer valid—Datadog automatically disables the rule and marks it as broken. | ||
|
|
||
| {{< img src="security/automation_pipelines/ticket_creation_broken_rule.png" alt="Automation Pipelines list showing a ticket creation rule with a warning tooltip that says 'Rule auto-disabled due to a ticketing integration error'" style="width:100%;" >}} | ||
|
|
||
| To resume automatic ticket creation, fix the project configuration and re-enable the rule. | ||
|
|
||
| ## Disabled or deleted rules | ||
|
|
||
| When you disable or delete a ticket creation rule, tickets that were previously created by the rule remain attached to their findings. They are not detached or deleted. | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [2]: https://app.datadoghq.com/security/configuration/findings-automation?opened-sections=create_ticket | ||
| [3]: /security/ticketing_integrations/ | ||
| [5]: /integrations/jira/#configure-a-jira-webhook | ||
Uh oh!
There was an error while loading. Please reload this page.