OpenPipeline API - GET technology processors

Latest Dynatrace
Reference
1-min read
Published Oct 25, 2024
Early Access

Gets all the processor for a technology bundle, given the technology bundle ID.

The request produces an application/json payload.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/technologies/{id}/processors`

You can execute this request also with an OAuth2 client with openpipeline:configurations:read permission.

To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of a technology bundle.	path	Required

Response

Response codes

Code	Type	Description
200	ProcessingStageProcessor[]	List of all processors within a specific technology bundle.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `ResponseBody` object

The `ProcessingStageProcessor` object

Groups all processors applicable for the ProcessingStage. Applicable processors are DqlProcessor, FieldsAddProcessor, FieldsRemoveProcessor, FieldsRenameProcessor, TechnologyProcessor, and DropProcessor.

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

[
  {
    "type": "dql",
    "enabled": true,
    "editable": false,
    "id": "es_slow_log",
    "description": "ES Slow Log Index",
    "matcher": "matchesPhrase(content, \"index.indexing.slowlog*\")",
    "sampleData": "{}",
    "dqlScript": "parse content, \"'[' TIMESTAMP('yyyy-MM-ddTHH:mm:ss,SSS'):timestamp ']' PUNCT?\nSPACE? '[' UPPER:loglevel SPACE* ']' PUNCT?\nSPACE? '[index.indexing.slowlog.' LD:'db.operation' ']' PUNCT?\nSPACE? '[' LD:'db.elasticsearch.node' ']' PUNCT?\n(SPACE? '{' LD '}')? //metadata, dt.trace_id\nSPACE? '[' LD?:'db.elasticsearch.index_name' ']' PUNCT?\nSPACE? 'took[' LD ']' PUNCT?\nSPACE? 'took_millis[' INT:'db.elasticsearch.duration' ']' PUNCT?\nDATA\"\n"
  }
]

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

JSON models

DqlProcessor

The `DqlProcessor` object

Processor to apply a DQL script.

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

FieldsAddProcessor

The `FieldsAddProcessor` object

Processor to add fields.

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

The `FieldsAddItem` object

List of fields to add to the record.

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

FieldsRemoveProcessor

The `FieldsRemoveProcessor` object

Processor to remove fields.

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

FieldsRenameProcessor

The `FieldsRenameProcessor` object

Processor to rename fields.

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

The `FieldsRenameItem` object

List of fields to rename on the record.

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

TechnologyProcessor

The `TechnologyProcessor` object

Processor to apply technology processors.

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

DropProcessor

The `DropProcessor` object

Processor to drop the record either during the processing stage or at the endpoint.

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

ErrorResponseEnvelope

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`

ConstraintViolationDetails

The `ConstraintViolationDetails` object

List of encountered constraint violations.

Element	Type	Description
constraintViolations	ConstraintViolation[]	List of encountered constraint violations.

The `ConstraintViolation` object

Information about a single constraint violation.

Element	Type	Description
context	object	Structured context of the constraint violation. Well known keys that can be present are: `reason` -> Additional reasoning behind the occurred violation. `pipeline` -> Pipeline related to the violation. `endpoint` -> Endpoint related to the violation. `stage` -> Stage related to the violation. `processor` -> Processor related to the violation. `routingRule` -> Routing rule related to the violation.
message	string	Description of the constraint violation.

GeoLookupProcessor

The `GeoLookupProcessor` object

Processor to perform geo IP lookup.

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

InlineLookupProcessor

The `InlineLookupProcessor` object

Processor to perform inline key-value lookup.

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

ClassicPipelineTranslationResult

The `ClassicPipelineTranslationResult` object

Result of translating a classic pipeline into an OpenPipeline configuration pipeline.

Element	Type	Description
value	PipelineSettingsValue	The translated OpenPipeline configuration pipeline. The structure is compliant with `builtin:openpipeline.logs.pipelines` or `builtin:openpipeline.bizevents.pipelines` schemas, corresponding to the requested `configuration` parameter value. Note: the raw result may not fully pass validation against the Settings API.
withWarning	boolean	Indicates whether at least one processor couldn't be translated automatically and needs manual review.

The `PipelineSettingsValue` object

The translated OpenPipeline configuration pipeline. The structure is compliant with builtin:openpipeline.logs.pipelines or builtin:openpipeline.bizevents.pipelines schemas, corresponding to the requested configuration parameter value. Note: the raw result may not fully pass validation against the Settings API.

PipelineSettingsValue

The `PipelineSettingsValue` object

OpenPipeline API - GET technology processors

Latest Dynatrace
Reference
1-min read
Published Oct 25, 2024
Early Access

Gets all the processor for a technology bundle, given the technology bundle ID.

The request produces an application/json payload.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/technologies/{id}/processors`

You can execute this request also with an OAuth2 client with openpipeline:configurations:read permission.

To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of a technology bundle.	path	Required

Response

Response codes

Code	Type	Description
200	ProcessingStageProcessor[]	List of all processors within a specific technology bundle.
4XX	ErrorResponseEnvelope	Client-side error.
5XX	ErrorResponseEnvelope	Server-side error.

Response body objects

The `ResponseBody` object

The `ProcessingStageProcessor` object

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

[
  {
    "type": "dql",
    "enabled": true,
    "editable": false,
    "id": "es_slow_log",
    "description": "ES Slow Log Index",
    "matcher": "matchesPhrase(content, \"index.indexing.slowlog*\")",
    "sampleData": "{}",
    "dqlScript": "parse content, \"'[' TIMESTAMP('yyyy-MM-ddTHH:mm:ss,SSS'):timestamp ']' PUNCT?\nSPACE? '[' UPPER:loglevel SPACE* ']' PUNCT?\nSPACE? '[index.indexing.slowlog.' LD:'db.operation' ']' PUNCT?\nSPACE? '[' LD:'db.elasticsearch.node' ']' PUNCT?\n(SPACE? '{' LD '}')? //metadata, dt.trace_id\nSPACE? '[' LD?:'db.elasticsearch.index_name' ']' PUNCT?\nSPACE? 'took[' LD ']' PUNCT?\nSPACE? 'took_millis[' INT:'db.elasticsearch.duration' ']' PUNCT?\nDATA\"\n"
  }
]

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

JSON models

DqlProcessor

The `DqlProcessor` object

Processor to apply a DQL script.

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

FieldsAddProcessor

The `FieldsAddProcessor` object

Processor to add fields.

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

The `FieldsAddItem` object

List of fields to add to the record.

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

FieldsRemoveProcessor

The `FieldsRemoveProcessor` object

Processor to remove fields.

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

FieldsRenameProcessor

The `FieldsRenameProcessor` object

Processor to rename fields.

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

The `FieldsRenameItem` object

List of fields to rename on the record.

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

TechnologyProcessor

The `TechnologyProcessor` object

Processor to apply technology processors.

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

DropProcessor

The `DropProcessor` object

Processor to drop the record either during the processing stage or at the endpoint.

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

ErrorResponseEnvelope

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`

ConstraintViolationDetails

The `ConstraintViolationDetails` object

List of encountered constraint violations.

Element	Type	Description
constraintViolations	ConstraintViolation[]	List of encountered constraint violations.

The `ConstraintViolation` object

Information about a single constraint violation.

Element	Type	Description
context	object	Structured context of the constraint violation. Well known keys that can be present are: `reason` -> Additional reasoning behind the occurred violation. `pipeline` -> Pipeline related to the violation. `endpoint` -> Endpoint related to the violation. `stage` -> Stage related to the violation. `processor` -> Processor related to the violation. `routingRule` -> Routing rule related to the violation.
message	string	Description of the constraint violation.

GeoLookupProcessor

The `GeoLookupProcessor` object

Processor to perform geo IP lookup.

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

InlineLookupProcessor

The `InlineLookupProcessor` object

Processor to perform inline key-value lookup.

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

ClassicPipelineTranslationResult

The `ClassicPipelineTranslationResult` object

Result of translating a classic pipeline into an OpenPipeline configuration pipeline.

Element	Type	Description
value	PipelineSettingsValue	The translated OpenPipeline configuration pipeline. The structure is compliant with `builtin:openpipeline.logs.pipelines` or `builtin:openpipeline.bizevents.pipelines` schemas, corresponding to the requested `configuration` parameter value. Note: the raw result may not fully pass validation against the Settings API.
withWarning	boolean	Indicates whether at least one processor couldn't be translated automatically and needs manual review.

The `PipelineSettingsValue` object

PipelineSettingsValue

OpenPipeline API - GET technology processors

Parameters

Response

Response codes

Response body objects

The ResponseBody object

The ProcessingStageProcessor object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

JSON models

The DqlProcessor object

The FieldsAddProcessor object

The FieldsAddItem object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The FieldsRenameItem object

The TechnologyProcessor object

The DropProcessor object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

The ConstraintViolationDetails object

The ConstraintViolation object

The GeoLookupProcessor object

The InlineLookupProcessor object

The ClassicPipelineTranslationResult object

The PipelineSettingsValue object

The PipelineSettingsValue object

OpenPipeline API - GET technology processors

Parameters

Response

Response codes

Response body objects

The ResponseBody object

The ProcessingStageProcessor object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

JSON models

The DqlProcessor object

The FieldsAddProcessor object

The FieldsAddItem object

The FieldsRemoveProcessor object

The FieldsRenameProcessor object

The FieldsRenameItem object

The TechnologyProcessor object

The DropProcessor object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

The ConstraintViolationDetails object

The ConstraintViolation object

The GeoLookupProcessor object

The InlineLookupProcessor object

The ClassicPipelineTranslationResult object

The PipelineSettingsValue object

The PipelineSettingsValue object

The `ResponseBody` object

The `ProcessingStageProcessor` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `DqlProcessor` object

The `FieldsAddProcessor` object

The `FieldsAddItem` object

The `FieldsRemoveProcessor` object

The `FieldsRenameProcessor` object

The `FieldsRenameItem` object

The `TechnologyProcessor` object

The `DropProcessor` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `ConstraintViolationDetails` object

The `ConstraintViolation` object

The `GeoLookupProcessor` object

The `InlineLookupProcessor` object

The `ClassicPipelineTranslationResult` object

The `PipelineSettingsValue` object

The `PipelineSettingsValue` object

The `ResponseBody` object

The `ProcessingStageProcessor` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `DqlProcessor` object

The `FieldsAddProcessor` object

The `FieldsAddItem` object

The `FieldsRemoveProcessor` object

The `FieldsRenameProcessor` object

The `FieldsRenameItem` object

The `TechnologyProcessor` object

The `DropProcessor` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `ConstraintViolationDetails` object

The `ConstraintViolation` object

The `GeoLookupProcessor` object

The `InlineLookupProcessor` object

The `ClassicPipelineTranslationResult` object

The `PipelineSettingsValue` object

The `PipelineSettingsValue` object