OpenPipeline API - GET technology processors

Early Adopter

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

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/openpipeline/v1/technologies/{id}/processors

Authentication

To execute this request, you need an access token with settings.read scope.

To learn how to obtain and use it, see Tokens and authentication.

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

List of all processors within a specific technology bundle.

4XX

Client-side error.

5XX

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": null,
"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:

  • 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

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 is allowed to edit this object based on permissions and builtin property.

processors

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

Processing stage configuration of the pipeline.

The ProcessingStage object

Processing stage configuration of the pipeline.

Element
Type
Description
editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

processors

List of processors.

The ProcessingStageProcessor object

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

The BizeventExtractionProcessor object

Processor to extract a bizevent. This processor can only be applied to the logs configuration. 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

eventProvider

Strategy to assign a value.

eventType

Strategy to assign a value.

fieldExtraction

Definition of the field extraction.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
  • 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

properties

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

Processor to apply a DQL script.

Element
Type
Description
description
string

Name or description of the processor.

dqlScript
string

The DQL script to apply on the record.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

sampleData
string

Sample data related to the processor for documentation or testing.

The FieldsAddProcessor object

Processor to add fields.

Element
Type
Description
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

fields

List of fields to add to the record.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to 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

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

sampleData
string

Sample data related to the processor for documentation or testing.

The FieldsRenameProcessor object

Processor to rename fields.

Element
Type
Description
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

fields

List of fields to rename on the record.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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.

description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
description
string

Name or description of the processor.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

sampleData
string

Sample data related to the processor for documentation or testing.

value

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
  • field
  • multiValueConstant

The CounterMetricExtractionProcessor object

Processor to write the occurrences as a metric.

Element
Type
Description
description
string

Name or description of the processor.

dimensions
string[]

List of unique dimensions to add to the metric.

editable
boolean

Indicates if the user is allowed to edit this object based on permissions and builtin property.

enabled
boolean

Indicates if the object is active.

id
string

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on 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
description
string

Name or description of the processor.

dimensions
string[]

List of unique dimensions to add to the metric.

editable
boolean

Indicates if the user is allowed to 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

Identifier of the processor. Must be unique within a stage.

matcher
string

Matching condition to apply on incoming records.

metricKey
string

The key of the metric to write.

sampleData
string

Sample data related to the processor for documentation or testing.

The ErrorResponseEnvelope object

Encloses the encountered error.

Element
Type
Description
error

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

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

The ConstraintViolationDetails object

List of encountered constraint violations.

Element
Type
Description
constraintViolations

List of encountered constraint violations.

The ConstraintViolation object

Information about a single constraint violation.

Element
Type
Description
message
string

Description of the constraint violation.