AWS devopsagent documentation change
Summary
Updated Dynatrace integration documentation with formatting fixes, corrected terminology, added detailed event schemas for Incident and Mitigation events, and changed 'Remove from agent space' to 'Deregister from account'
Security assessment
The changes are primarily documentation improvements, formatting corrections, and adding technical details about event schemas. No security vulnerabilities, fixes, or security features are mentioned. The changes include webhook details but these are standard integration instructions without security implications.
Diff
diff --git a/devopsagent/latest/userguide/connecting-telemetry-sources-connecting-dynatrace.md b/devopsagent/latest/userguide/connecting-telemetry-sources-connecting-dynatrace.md index 4aae5e325..c9fcf6d85 100644 --- a//devopsagent/latest/userguide/connecting-telemetry-sources-connecting-dynatrace.md +++ b//devopsagent/latest/userguide/connecting-telemetry-sources-connecting-dynatrace.md @@ -34 +34 @@ Onboarding your Dynatrace observability system involves three stages: - 3. **Configure your Dynatrace environment -** download the workflows and dashboard and import into Dynatrace, making a note of the webhooks ****details to trigger investigations in designated Agent spaces + 3. **Configure your Dynatrace environment** \- download the workflows and dashboard and import into Dynatrace, making a note of the webhook details to trigger investigations in designated Agent spaces @@ -55 +55 @@ Establish connection to your Dynatrace environment - 3. You can connect multiple dynatrace environments and later scope to specific ones for each DevOps Agent Space you may have. + 3. You can connect multiple Dynatrace environments and later scope to specific ones for each DevOps Agent Space you may have. @@ -59 +59 @@ Establish connection to your Dynatrace environment - 1. **Client Name** + * **Client Name** @@ -61 +61 @@ Establish connection to your Dynatrace environment - 2. **Client ID** + * **Client ID** @@ -63 +63 @@ Establish connection to your Dynatrace environment - 3. **Client Secret** + * **Client Secret** @@ -65 +65 @@ Establish connection to your Dynatrace environment - 4. **Account URN** + * **Account URN** @@ -94 +94 @@ Activate Dynatrace in a specific Agent space and configure appropriate scoping - 8. Copy the Webhook URL and Webhook Secret and follow the instructions [[https://docs.dynatrace.com/docs/shortlink/aws-devops-agent](https://docs.dynatrace.com/docs/shortlink/aws-devops-agent)] to add this credentials to Dynatrace. + 8. Copy the Webhook URL and Webhook Secret. See [Dynatrace documentation](https://docs.dynatrace.com/docs/shortlink/aws-devops-agent) to add these credentials to Dynatrace. @@ -101 +101,32 @@ Activate Dynatrace in a specific Agent space and configure appropriate scoping -To complete your Dynatrace set up you will need to perform certain setup steps in your Dynatrace environment. Follow the instructions here: [https://docs.dynatrace.com/docs/shortlink/aws-devops-agent](https://docs.dynatrace.com/docs/shortlink/aws-devops-agent) +To complete your Dynatrace set up you will need to perform certain setup steps in your Dynatrace environment. Follow the instructions in the [Dynatrace documentation](https://docs.dynatrace.com/docs/shortlink/aws-devops-agent). + +#### Supported Event Schemas + +AWS DevOps Agent supports two types of events from Dynatrace using webhooks. The supported event schemas are documented below: + +##### Incident Event + +Incident events are used to trigger an investigation. The event schema is: + + + { + "event.id": string; + "event.status": "ACTIVE" | "CLOSED"; + "event.status_transition": string; + "event.description": string; + "event.name": string; + "event.category": "AVAILABILITY" | "ERROR" | "SLOWDOWN" | "RESOURCE_CONTENTION" | "CUSTOM_ALERT" | "MONITORING_UNAVAILABLE" | "INFO"; + "event.start"?: string; + "affected_entity_ids"?: string[]; + } + +##### Mitigation Event + +Mitigation events are used to trigger generating a mitigation report for the investigation on next steps. The event schema is: + + + { + "task_id": string; + "task_version": number; + "event.type": "mitigation_request"; + } @@ -122 +153 @@ The telemetry source is connected at two levels at the agent space level and at -### Step 2: Remove from agent space +### Step 2: Deregister from account