Edge Delta Configuration Imports

Use parent configuration.

  2 minute read  

Configuration v2

Overview

In the agent configuration yaml, you can reference an existing configuration - a child configuration in the imports section. See the instructions for configuring an agent.

Note

  • You can reference a child configuration in multiple parent configurations.
  • You cannot reference a configuration that itself references child configurations.
  • The user who created or updates the parent configuration must have access to the child configuration.
  • If parent and child configurations have sources that point to the same resource, such as a file input that has the same path, then these 2 sources will only be merged if they have the same configuration, with the exception of labels. If not, then the configuration validation will give an error.

Examples

imports:
      - name: "<Name of the config>" 
        conf_id: "<Config ID>" 
        prefix: "<Prefix>"  
        exclude_workflows: true  
        params: 
          WorkflowProcessor: "flog"

imports:
- name: "Test_Team"
  conf_id: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
  prefix: test_team
  params:
    ElasticIndexName: TEST_INDEX

Parameters

name

Enter the name of the child configuration.

name: "Test_Team"

conf_id

Enter the configuration ID or the API key for the child configuration.

conf_id: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

prefix

Enter a descriptive term that will be inserted in front of the metrics, inputs, filters, etc. from that configuration.

If you do not enter a prefix, then the name of the child configuration will be used.

prefix: test_team

exclude_workflows

Enter true or false.

False indicates that the parent configuration will not use the workflows from the child configuration.

The default value is false.

exclude_workflows: true

params

Enter a key-value pair that will be used for templating purposes for the child configuration.

To avoid errors during the configuration validation process, in the workflow, use the following format: '{{ Param "KEY" }}'

Parametrization only works for the child configuration’s workflow. If you enter “… ‘{{ Param “” }}’ …”, then the will replace all content within the curly brackets.

params: 
  WorkflowProcessor: "flog"