Update the Analytics CR to customize data in your IBM® API
Connect Analytics
deployment.
Before you begin
Review the use of filters for modifying analytics data, and make sure that you understand the
restrictions. For information about customizing data, see Planning to modify your analytics data.
About this task
Customizing the analytics data is optional. You can enable the inclusion of geoIP information,
and define filters that add, modify, or remove other fields.
Upgrade note: In V2018, multiple configuration files were used for
defining filters that were applied at different points in the ingestion pipeline. In V10, you define
filters in the analytics_cr.yaml file.
Procedure
-
Open the analytics_cr.yaml file for editing.
-
Enable the inclusion of geoIP fields in your analytics data by locating the
ingestion
section and inserting the following lines:
spec:
ingestion:
...
geoIPEnabled: true
By default the client_geoip
and gateway_geoip
fields are not
included in the analytics data. These are calculated from the client_ip
and
gateway_ip
fields, respectively. Setting geoIPEnabled
to
true
enables this feature.
-
Locate the appropriate
filter
section and add a filter definition.
You can add filters for ingestion
and for offloading
, so be
sure to add your filter to the correct section. For information about where to add filters for local
data and offloaded data, see Which pipeline is affected by the filter?.
For example filters, see Sample filters for modifying analytics data.
For example, you can add a filter into the ingestion
section, just after the
geoip filter added in the previous step. The following example filter removes the
query_string
field:
spec:
ingestion:
...
geoIPEnabled: true
filter: |
mutate {
remove_field => ["query_string"]
}
-
Save the file.
What to do next
Proceed to the topic on Defining your internal storage space, which is the
last step before running the installation.