Settings API - Custom log sources schema table

Custom log sources (builtin:logmonitoring.custom-log-source-settings)

Add custom log sources before creating log ingest rule in case of:

  • process is not important (this mean that log source is not automatically discovered by OneAgent)
  • logs from Windows event logs (other than Windows system log, Windows security log, or Windows Application log)
  • AIX logs
  • allowing binary content
  • unsupported rotation pattern

OneAgent automatically discovers new log files for important processes on supported platforms. Auto-detected logs are listed on the Process Group Instance or Host screen.

Schema IDSchema groupsScope
builtin:logmonitoring.custom-log-source-settings
  • group:log-monitoring
  • group:log-monitoring.ingest-and-processing
HOST - Host
KUBERNETES_CLUSTER - Kubernetes cluster
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:logmonitoring.custom-log-source-settings
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:logmonitoring.custom-log-source-settings
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:logmonitoring.custom-log-source-settings

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
Active
enabled		boolean-required
Name
config-item-title		text-required
custom-log-sourceCustomLogSource-required
Log Source context
context		Set<Context>

Define Custom Log Source only within context if provided

required
The CustomLogSource object
PropertyTypeDescriptionRequired
Log Source type
type		enum
  • LOG_PATH_PATTERN
  • WINDOWS_EVENT_LOG
required
Accept binary content
accept-binary		boolean-optional
Encoding
encoding		text-optional
Log source
values-and-enrichment		Set<CustomLogSourceWithEnrichment>

It might be either an absolute path to log(s) with optional wildcards or Windows Event Log name.

required
The Context object
PropertyTypeDescriptionRequired
Attribute
attribute		enum
  • dt.entity.process_group
required
valuesset-required
The CustomLogSourceWithEnrichment object
PropertyTypeDescriptionRequired
Values
path		text-required
Enrichments
enrichment		Set<Enrichment>

Optional field that allows to define attributes that will enrich logs

${N} can be used in attribute value to expand the value matched by wildcards where N denotes the number of the wildcard the expand

required
The Enrichment object
PropertyTypeDescriptionRequired
type
type		enum
  • attribute
required
key
key		text-optional
value
value		text-optional