Settings API - Log events schema table

  • Published Dec 05, 2023

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 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

PropertyTypeDescriptionRequired
Enabled
enabled		boolean-Required
Summary
summary		text

The textual summary of the log event entry

Required
Matcher
query		text-Required
Event template
eventTemplate		EventTemplate-Required
The EventTemplate object
PropertyTypeDescriptionRequired
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
Event type
eventType		enum

The event type to trigger.

The element has these enums
  • INFO
  • ERROR
  • AVAILABILITY
  • SLOWDOWN
  • RESOURCE
  • CUSTOM_ALERT
  • CUSTOM_ANNOTATION
  • CUSTOM_CONFIGURATION
  • CUSTOM_DEPLOYMENT
  • MARKED_FOR_TERMINATION
  • WARNING
Required
Allow merge
davisMerge		boolean

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

Required
Properties
metadata		Set<MetadataItem>

Set of additional key-value properties to be attached to the triggered event. You can retrieve the available property keys using the Events API v2.

Required
The MetadataItem object
PropertyTypeDescriptionRequired
Key
metadataKey		text

Type 'dt.' for key hints.

Required
Value
metadataValue		text

Type '{' for placeholder hints.

Required