OpenPipeline API - GET technology processors

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

Early Adopter

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.

Response body JSON model

[
  {
    "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"
  }
]

JSON models

The `ConstantValueAssignment` object

Assign a constant value.

Element	Type	Description
constant	string	The constant value to assign.

The `FieldValueAssignment` object

Assign a value extracted from a field.

Element	Type	Description
field	string	The field on the record to extract the value for assignment.

The `ConstantMultiValueAssignment` object

Assign a multi-value constant.

Element	Type	Description
multiValueConstant	string[]	The constant multi value to assign.

The `StaticRouting` object

Records are statically routed to the defined pipeline.

Element	Type	Description
pipelineId	string	Identifier of the pipeline.

The `DynamicRouting` object

Records are routed via the dynamic routes.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `static` -> StaticRouting `dynamic` -> DynamicRouting `dynamic` `static`

The `ClassicPipelineDefinition` object

Definition of a classic pipeline which are configured via settings 2.0. This only applies to the logs and bizevents configuration.

Element	Type	Description
processing	ClassicProcessingStage	Processing stage configuration of the pipeline.
settingsSchema	string	The settings-schema identifier related to the processing of the classic pipeline.

The `ClassicProcessingStage` object

Processing stage configuration of the pipeline.

Element	Type	Description
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
processors	ClassicProcessingStageProcessor[]	List of processors.

The `ClassicProcessingStageProcessor` object

Groups all processors applicable for the ClassicProcessingStage. Applicable processor is SxqlProcessor.

The `DefaultPipelineDefinition` object

Definition of a single default pipeline.

Element	Type	Description
processing	ProcessingStage	Processing stage configuration of the pipeline.

The `ProcessingStage` object

Processing stage configuration of the pipeline.

Element	Type	Description
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
processors	ProcessingStageProcessor[]	List of processors.

The `ProcessingStageProcessor` object

The `BizeventExtractionProcessor` object

Processor to extract a bizevent. Fields event.type and event.provider can only be assigned to a constant or field value. A multi-value constant is not supported for those 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.
eventProvider	ValueAssignment	Strategy to assign a value.
eventType	ValueAssignment	Strategy to assign a value.
fieldExtraction	FieldsExtraction	Definition of the field extraction.
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 `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `FieldsExtraction` object

Definition of the field extraction.

Element	Type	Description
fields	string[]	Unique fields to include/exclude in the extracted record.
semantic	string	Defines how the fields of the source record should be extracted. INCLUDE: Only the specified fields are extracted. INCLUDE_ALL: All fields are extracted. EXCLUDE: All fields except the specified fields are extracted. `EXCLUDE` `INCLUDE` `INCLUDE_ALL`

The `DavisEventExtractionProcessor` object

Processor to extract a davis event.

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.
properties	DavisEventProperty[]	List of properties for the extracted davis event.
sampleData	string	Sample data related to the processor for documentation or testing.

The `DavisEventProperty` object

List of properties for the extracted davis event.

Element	Type	Description
key	string	The key to set on the davis event.
value	string	The value assigned to the key.

The `SecurityEventExtractionProcessor` object

Processor to extract a security event.

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.
fieldExtraction	FieldsExtraction	Definition of the field extraction.
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 `FieldsExtraction` object

Definition of the field extraction.

Element	Type	Description
fields	string[]	Unique fields to include/exclude in the extracted record.
semantic	string	Defines how the fields of the source record should be extracted. INCLUDE: Only the specified fields are extracted. INCLUDE_ALL: All fields are extracted. EXCLUDE: All fields except the specified fields are extracted. `EXCLUDE` `INCLUDE` `INCLUDE_ALL`

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

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.

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.

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.

The `TechnologyProcessor` object

Processor to apply a 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 is 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 on the record.

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.

The `NoStorageProcessor` object

Processor to skip storage assignment.

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.

The `BucketAssignmentProcessor` object

Processor to assign a bucket.

Element	Type	Description
bucketName	string	Bucket that is assigned when the record is matched.
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.

The `SecurityContextProcessor` object

Processor to set the security context field.

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.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `CounterMetricExtractionProcessor` object

Processor to write the occurrences as a metric.

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.
dimensions	string[]	List of unique dimensions to add to the metric. Dimensions are represented in the format `({dimensionName}=)?{sourceField}`. `{dimensionName}` is optional if `{sourceField}` represents a valid metric dimension name. `{sourceField}` has to represent a valid DQL field accessor and it can access a nested field (for example, `field[field2][0]`).
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.
metricKey	string	The key of the metric to write.
sampleData	string	Sample data related to the processor for documentation or testing.

The `ValueMetricExtractionProcessor` object

Processor to extract a value from a field as a metric.

Element	Type	Description
builtin	boolean	Indicates if Dynatrace provides the object or if it's customer-defined.
defaultValue	string	The default value to use if the given field value could not be extracted. String value must be a number.
description	string	Name or description of the processor.
dimensions	string[]	List of unique dimensions to add to the metric. Dimensions are represented in the format `({dimensionName}=)?{sourceField}`. `{dimensionName}` is optional if `{sourceField}` represents a valid metric dimension name. `{sourceField}` has to represent a valid DQL field accessor and it can access a nested field (for example, `field[field2][0]`).
editable	boolean	Indicates if the user can edit this object based on permissions and builtin property.
enabled	boolean	Indicates if the object is active.
field	string	The field to extract the value for the metric.
id	string	Processor identifier, which must be unique within a stage.
matcher	string	Matching condition to apply to incoming records.
metricKey	string	The key of the metric to write.
sampleData	string	Sample data related to the processor for documentation or testing.

The `CostAllocationProcessor` object

Processor to set the cost allocation field.

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.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

The `ProductAllocationProcessor` object

Processor to set the product allocation field.

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.
value	ValueAssignment	Strategy to assign a value.

The `ValueAssignment` object

Strategy to assign a value.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constant` -> ConstantValueAssignment `field` -> FieldValueAssignment `multiValueConstant` -> ConstantMultiValueAssignment `constant` `field` `multiValueConstant`

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

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.

OpenPipeline API - GET technology processors

Parameters

Response

Response codes

Response body objects

The ResponseBody object

The ProcessingStageProcessor object

Response body JSON model

JSON models

The ConstantValueAssignment object

The FieldValueAssignment object

The ConstantMultiValueAssignment object

The StaticRouting object

The DynamicRouting object

The ClassicPipelineDefinition object

The ClassicProcessingStage object

The ClassicProcessingStageProcessor object

The DefaultPipelineDefinition object

The ProcessingStage object

The ProcessingStageProcessor object

The BizeventExtractionProcessor object

The ValueAssignment object

The FieldsExtraction object

The DavisEventExtractionProcessor object

The DavisEventProperty object

The SecurityEventExtractionProcessor object

The FieldsExtraction 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 NoStorageProcessor object

The BucketAssignmentProcessor object

The SecurityContextProcessor object

The ValueAssignment object

The CounterMetricExtractionProcessor object

The ValueMetricExtractionProcessor object

The CostAllocationProcessor object

The ValueAssignment object

The ProductAllocationProcessor object

The ValueAssignment object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

The ConstraintViolationDetails object

The ConstraintViolation object

The `ResponseBody` object

The `ProcessingStageProcessor` object

The `ConstantValueAssignment` object

The `FieldValueAssignment` object

The `ConstantMultiValueAssignment` object

The `StaticRouting` object

The `DynamicRouting` object

The `ClassicPipelineDefinition` object

The `ClassicProcessingStage` object

The `ClassicProcessingStageProcessor` object

The `DefaultPipelineDefinition` object

The `ProcessingStage` object

The `ProcessingStageProcessor` object

The `BizeventExtractionProcessor` object

The `ValueAssignment` object

The `FieldsExtraction` object

The `DavisEventExtractionProcessor` object

The `DavisEventProperty` object

The `SecurityEventExtractionProcessor` object

The `FieldsExtraction` 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 `NoStorageProcessor` object

The `BucketAssignmentProcessor` object

The `SecurityContextProcessor` object

The `ValueAssignment` object

The `CounterMetricExtractionProcessor` object

The `ValueMetricExtractionProcessor` object

The `CostAllocationProcessor` object

The `ValueAssignment` object

The `ProductAllocationProcessor` object

The `ValueAssignment` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `ConstraintViolationDetails` object

The `ConstraintViolation` object