Preview a processor

Latest Dynatrace
Reference

Preview a processor in Dynatrace OpenPipeline with sample data, and see the processed sample record for the config and scope you provide.


POST	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/preview/processor`

Overview

You send configId, processor, and scope in the request body. Dynatrace returns a preview result containing the processed sample data record.

Authentication

To execute this request, you need a platform token or OAuth access token with openpipeline:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	PreviewProcessorEnvelope	The processor with sample-data to preview.	body	Required

Request body objects

The `PreviewProcessorEnvelope` object

Element	Type	Description	Required
configId	string	Identifier of the configuration.	Optional
processor	DqlProcessor \| FieldsAddProcessor \| FieldsRemoveProcessor \| FieldsRenameProcessor \| TechnologyProcessor \| GeoLookupProcessor \| InlineLookupProcessor	The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor, GeoLookupProcessor, and InlineLookupProcessor.	Required
scope	string	The scope in which the processor is previewed in. The element can hold these values `ENDPOINT` `PIPELINE`	Optional

The `PreviewProcessor` object

The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor, GeoLookupProcessor, and InlineLookupProcessor.

The `DqlProcessor` object

Processor to apply a DQL script.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
dqlScript	string	The DQL script to apply on the record.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsAddProcessor` object

Processor to add fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	FieldsAddItem[]	List of fields to add to the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsRemoveProcessor` object

Processor to remove fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	string[]	List of unique fields to remove from the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsRenameProcessor` object

Processor to rename fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	FieldsRenameItem[]	List of fields to rename on the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `TechnologyProcessor` object

Processor to apply a technology processors.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
customMatcher	string	Optional customer-defined matching condition, that's used in place of the main technology matcher.	Optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional
technologyId	string	The reference identifier to a specific technology. This technology is applied on the record.	Required

The `GeoLookupProcessor` object

Processor to perform geo IP lookup.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
geoFieldPrefix	string	Optional prefix for geo output fields.	Optional
id	string	Processor identifier, which must be unique within a stage.	Required
ipFieldKey	string	The record field that contains the IP address to look up.	Required
matcher	string	Matching condition to apply to incoming records.	Required
outputFields	string[]	List of output fields to populate from the geo lookup.	Optional
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `InlineLookupProcessor` object

Processor to perform inline key-value lookup.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
defaultValue	string	Value to use when no lookup entry matches the source field.	Optional
description	string	Name or description of the processor.	Required
destinationField	string	The record field to write the lookup result to.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
inlineLookupTable	string	JSON array of inline lookup entries mapping keys to values.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional
sourceField	string	The record field to use as the lookup key.	Required

The `FieldsAddItem` object

List of fields to add to the record.

Element	Type	Description	Required
name	string	Name of the field.	Required
value	string	Value to assign to the field.	Required

The `FieldsRenameItem` object

List of fields to rename on the record.

Element	Type	Description	Required
fromName	string	The field to rename.	Required
toName	string	The new field name.	Required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "processor": {
    "type": "fieldsRename",
    "enabled": false,
    "editable": true,
    "id": "hostname-field-normalizer",
    "description": "hostname field normalizer",
    "matcher": "isNotNull(\"hostname\")",
    "sampleData": "{\"hostname\": \"raspberry-pi 4\",\"ip\":\"10.0.0.123\"}",
    "fields": [
      {
        "fromName": "hostname",
        "toName": "host.name"
      },
      {
        "fromName": "ip",
        "toName": "ip.address"
      }
    ]
  }
}

Response

Response codes

Code	Type	Description
200	PreviewProcessorResult	Preview result containing the processed sample data record.
408	ErrorResponseEnvelope	Preview run resulted in a timeout.
429	ErrorResponseEnvelope	Too many concurrent preview requests.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `PreviewProcessorResult` object

Element	Type	Description
results	PreviewProcessorResultEntry[]	List of results for each sample data record.

The `PreviewProcessorResultEntry` object

Preview result for a single sample data record.

Element	Type	Description
matched	boolean	Indicates if the record matched the processors matching condition.
matchedProcessors	string[]	Contains matched processors IDs, useful in case of multi-processors preview like in case of Technology.
record	object	The altered record after the processor was applied.

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails The element can hold these values `constraintViolation`

Response body JSON models

{
  "results": [
    {
      "matched": true,
      "record": {
        "ip.address": "10.0.0.123",
        "host.name": "raspberry-pi 4",
        "timestamp": "2024-06-24T07:21:52.200000000Z"
      }
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "Bad request."
  }
}

Preview a processor

Latest Dynatrace
Reference

Preview a processor in Dynatrace OpenPipeline with sample data, and see the processed sample record for the config and scope you provide.


POST	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/preview/processor`

Overview

You send configId, processor, and scope in the request body. Dynatrace returns a preview result containing the processed sample data record.

Authentication

To execute this request, you need a platform token or OAuth access token with openpipeline:configurations:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	PreviewProcessorEnvelope	The processor with sample-data to preview.	body	Required

Request body objects

The `PreviewProcessorEnvelope` object

Element	Type	Description	Required
configId	string	Identifier of the configuration.	Optional
processor	DqlProcessor \| FieldsAddProcessor \| FieldsRemoveProcessor \| FieldsRenameProcessor \| TechnologyProcessor \| GeoLookupProcessor \| InlineLookupProcessor	The processor to execute for the preview. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor, GeoLookupProcessor, and InlineLookupProcessor.	Required
scope	string	The scope in which the processor is previewed in. The element can hold these values `ENDPOINT` `PIPELINE`	Optional

The `PreviewProcessor` object

The `DqlProcessor` object

Processor to apply a DQL script.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
dqlScript	string	The DQL script to apply on the record.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsAddProcessor` object

Processor to add fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	FieldsAddItem[]	List of fields to add to the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsRemoveProcessor` object

Processor to remove fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	string[]	List of unique fields to remove from the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `FieldsRenameProcessor` object

Processor to rename fields.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
fields	FieldsRenameItem[]	List of fields to rename on the record.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `TechnologyProcessor` object

Processor to apply a technology processors.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
customMatcher	string	Optional customer-defined matching condition, that's used in place of the main technology matcher.	Optional
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional
technologyId	string	The reference identifier to a specific technology. This technology is applied on the record.	Required

The `GeoLookupProcessor` object

Processor to perform geo IP lookup.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
description	string	Name or description of the processor.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
geoFieldPrefix	string	Optional prefix for geo output fields.	Optional
id	string	Processor identifier, which must be unique within a stage.	Required
ipFieldKey	string	The record field that contains the IP address to look up.	Required
matcher	string	Matching condition to apply to incoming records.	Required
outputFields	string[]	List of output fields to populate from the geo lookup.	Optional
sampleData	string	Sample data related to the processor for documentation or testing.	Optional

The `InlineLookupProcessor` object

Processor to perform inline key-value lookup.

Element	Type	Description	Required
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.	Optional
defaultValue	string	Value to use when no lookup entry matches the source field.	Optional
description	string	Name or description of the processor.	Required
destinationField	string	The record field to write the lookup result to.	Required
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.	Optional
enabled	boolean	Indicates if the object is active.	Required
id	string	Processor identifier, which must be unique within a stage.	Required
inlineLookupTable	string	JSON array of inline lookup entries mapping keys to values.	Required
matcher	string	Matching condition to apply to incoming records.	Required
sampleData	string	Sample data related to the processor for documentation or testing.	Optional
sourceField	string	The record field to use as the lookup key.	Required

The `FieldsAddItem` object

List of fields to add to the record.

Element	Type	Description	Required
name	string	Name of the field.	Required
value	string	Value to assign to the field.	Required

The `FieldsRenameItem` object

List of fields to rename on the record.

Element	Type	Description	Required
fromName	string	The field to rename.	Required
toName	string	The new field name.	Required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "processor": {
    "type": "fieldsRename",
    "enabled": false,
    "editable": true,
    "id": "hostname-field-normalizer",
    "description": "hostname field normalizer",
    "matcher": "isNotNull(\"hostname\")",
    "sampleData": "{\"hostname\": \"raspberry-pi 4\",\"ip\":\"10.0.0.123\"}",
    "fields": [
      {
        "fromName": "hostname",
        "toName": "host.name"
      },
      {
        "fromName": "ip",
        "toName": "ip.address"
      }
    ]
  }
}

Response

Response codes

Code	Type	Description
200	PreviewProcessorResult	Preview result containing the processed sample data record.
408	ErrorResponseEnvelope	Preview run resulted in a timeout.
429	ErrorResponseEnvelope	Too many concurrent preview requests.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `PreviewProcessorResult` object

Element	Type	Description
results	PreviewProcessorResultEntry[]	List of results for each sample data record.

The `PreviewProcessorResultEntry` object

Preview result for a single sample data record.

Element	Type	Description
matched	boolean	Indicates if the record matched the processors matching condition.
matchedProcessors	string[]	Contains matched processors IDs, useful in case of multi-processors preview like in case of Technology.
record	object	The altered record after the processor was applied.

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails The element can hold these values `constraintViolation`

Response body JSON models

{
  "results": [
    {
      "matched": true,
      "record": {
        "ip.address": "10.0.0.123",
        "host.name": "raspberry-pi 4",
        "timestamp": "2024-06-24T07:21:52.200000000Z"
      }
    }
  ]
}

{
  "error": {
    "code": 400,
    "message": "Bad request."
  }
}

Preview a processor

Overview

Authentication

Parameters

Request body objects

The PreviewProcessorEnvelope object

The PreviewProcessor object

The DqlProcessor object

The FieldsAddProcessor object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The TechnologyProcessor object

The GeoLookupProcessor object

The InlineLookupProcessor object

The FieldsAddItem object

The FieldsRenameItem object

Request body JSON model

Response

Response codes

Response body objects

The PreviewProcessorResult object

The PreviewProcessorResultEntry object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

Preview a processor

Overview

Authentication

Parameters

Request body objects

The PreviewProcessorEnvelope object

The PreviewProcessor object

The DqlProcessor object

The FieldsAddProcessor object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The TechnologyProcessor object

The GeoLookupProcessor object

The InlineLookupProcessor object

The FieldsAddItem object

The FieldsRenameItem object

Request body JSON model

Response

Response codes

Response body objects

The PreviewProcessorResult object

The PreviewProcessorResultEntry object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

The `PreviewProcessorEnvelope` object

The `PreviewProcessor` object

The `DqlProcessor` object

The `FieldsAddProcessor` object

The `FieldsRemoveProcessor` object

The `FieldsRenameProcessor` object

The `TechnologyProcessor` object

The `GeoLookupProcessor` object

The `InlineLookupProcessor` object

The `FieldsAddItem` object

The `FieldsRenameItem` object

The `PreviewProcessorResult` object

The `PreviewProcessorResultEntry` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `PreviewProcessorEnvelope` object

The `PreviewProcessor` object

The `DqlProcessor` object

The `FieldsAddProcessor` object

The `FieldsRemoveProcessor` object

The `FieldsRenameProcessor` object

The `TechnologyProcessor` object

The `GeoLookupProcessor` object

The `InlineLookupProcessor` object

The `FieldsAddItem` object

The `FieldsRenameItem` object

The `PreviewProcessorResult` object

The `PreviewProcessorResultEntry` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object