• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Log events

Settings API - Log events schema table

Log events (builtin:logmonitoring.log-events)

Configure log patterns that trigger events for alerting and Davis® analysis. View Documentation. Note that log event detection consumes Davis® data units

Schema IDSchema groupsScope
builtin:logmonitoring.log-events
  • group:log-monitoring.analysis
  • group:log-monitoring
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:logmonitoring.log-events
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:logmonitoring.log-events
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
summarySummarytext

The textual summary of the log event entry

required
queryLog querytext-required
eventTemplateEvent templateEventTemplate-required

Request body objects

The MetadataItem object
PropertyLabelTypeDescriptionRequired
metadataKeyKeytext

Type 'dt.' for key hints.

required
metadataValueValuetext

Type '{' for placeholder hints.

required
The EventTemplate object
PropertyLabelTypeDescriptionRequired
titleTitletext

The title of the event to trigger. Type '{' for placeholder hints.

required
descriptionDescriptiontext

The description of the event to trigger. Type '{' for placeholder hints.

required
eventTypeEvent typeenum

The event type to trigger.

required
davisMergeAllow mergeboolean

Davis® AI will try to merge this event into existing problems, otherwise a new problem will always be created.

required
metadataPropertiesset

Set of additional key-value properties to be attached to the triggered event.

required