Configuration files for analytics offload customization

Beginning with API Connect version 2018.3.7, settings for analytics offload customization are maintained in the offload_output.conf, 19_filter.conf, 39_filter.conf, 49_apic_filter.conf, and 69_apic_filter.conf files.

The settings for configuring the offload of analytics data are contained in multiple files to make it easier to customize the content. Each of these files is displayed as a tab in the Cloud Manager Console. The files can be opened and changed in the Cloud Manager Console by following the instructions in Configuring output plugins for analytics offload.

outputs.yml file

The outputs.yml file is where you set the values for enabling and disabling the settings for where your analytics events are maintained. You can offload the data to a third-party collection repository, maintain the data on the API Connect internal collection repository, enable both methods to collect the data internally and externally, or disable them both to collect no analytics data. To enable the offloading of data, the value for the offload_output_enabled setting must be set to true. If the offload_output_enabled is set to false, no data is offloaded to an external repository. To maintain the data in the internal API Connect analytics data collection repository, the apic_output_enabled setting must be set to true.

When the value of the apic_output_enabled parameter is set to false, the internal API Connect analytics data collection is disabled. There is no analytics data captured internally when this is set to false.

Important: When the values of the offload_output_enabled and the apic_output_enabled parameters are both set to false, no analytics data is being collected.

The following example shows sample contents of the outputs.yml file:

apic_output_enabled: true
offload_output_enabled: false

offload_output.conf file

You can specify outputs in the offload_output.conf file to identify which API events that you want to offload. The API events that are not offloaded are either collected in the API Connect if internal analytics data collection is enabled, or discarded if it is not enabled.

The following example shows sample contents of the offload_output.conf file:

output {
  if "apicapievent" in [tags] {
    
  }
}

19_filter.conf

You can specify filters in the 19_filter.conf file to apply filters to the data immediately after it enters the pipeline from the gateway.

Note: Do not filter using this file unless you are instructed to do so by the API Connect support team.

The following example shows sample contents of the 19_filter.conf file:

filter {
  if "apicapievent" in [tags] {
  }
}

39_filter.conf

You can specify filters in the 39_filter.conf file to that apply to the data after it is filtered according to the settings in the 19_filter.conf file.

Note: Do not filter using this file unless you are instructed to do so by the API Connect support team.

The following example shows sample contents of the 39_filter.conf file:

filter {
  if "apicapievent" in [tags] {
  }
}

49_apic_filter.conf

You can specify filters in the 49_apic_filter.conf file to that apply to the data after it is filtered according to the settings in the 19_filter.conf file and the 39_filter.conf file.

Note: Do not filter using this file unless you are instructed to do so by the API Connect support team.

The following example shows sample contents of the 49_apic_filter.conf file:

filter {
  if "apicapievent" in [tags] {
  }
}

69_apic_filter.conf

You can specify filters in the 69_apic_filter.conf file to that apply to the data after it is filtered according to the settings in the 19_filter.conf file, the 39_filter file, and the 49_apic_filter.conf file. The filter settings in this file only affect the analytics data that is stored on the internal API Connect analytics data collection. It cannot be used to filter offloaded data.

You can filter the events in this file based on the event record fields that are described in API event record fields.

The following example shows sample contents of the 69_apic_filter.conf file:

filter {
  if "apicapievent" in [tags] {
  }
}