Settings API - Log events schema table
Log events (builtin:logmonitoring.log-events)
Configure log patterns that trigger events for alerting and Davis® analysis. Note that log event detection consumes Davis® data units
Schema ID | Schema groups | Scope |
---|---|---|
builtin:logmonitoring.log-events |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:logmonitoring.log-events |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:logmonitoring.log-events | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:logmonitoring.log-events |
Authentication
To execute this request, you need an access token with Read settings (settings.read
) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Property | Label | Type | Description | Required |
---|---|---|---|---|
enabled | Enabled | boolean | - | required |
summary | Summary | text | The textual summary of the log event entry | required |
query | Log query | text | - | required |
eventTemplate | Event template | EventTemplate | - | required |
Request body objects
The MetadataItem
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
metadataKey | Key | text | Type 'dt.' for key hints. | required |
metadataValue | Value | text | Type '{' for placeholder hints. | required |
The EventTemplate
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
title | Title | text | The title of the event to trigger. Type '{' for placeholder hints. | required |
description | Description | text | The description of the event to trigger. Type '{' for placeholder hints. | required |
eventType | Event type | enum | The event type to trigger. | required |
davisMerge | Allow merge | boolean | Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created. | required |
metadata | Properties | set | Set of additional key-value properties to be attached to the triggered event. | required |