Reference: Fields in the Analytics CR
Use the table of Analytics-specific fields to configure the CR for installing your IBM® API Connect Analytics subsystem.
Table 1 lists the Analytics-specific fields in the analytics_cr.yaml file
and describes each field. In Table 1, fields are shown using dot notation to indicate nested
sections. For example, the field specified in Table 1 as
storage.data.volumeClaimTemplate.volumeSize should be formatted in the CR as
follows:
storage:
data:
volumeClaimTemplate:
volumeSize:| Field | Type | Required | Default value | Description | Comments |
|---|---|---|---|---|---|
| client.enabled | boolean | no | true |
Whether to deploy this microservice | This microservice serves the Analytics UI and REST API. Only disable it if you do not need the Analytics views in API Connect. |
| client.endpoint | object | only if client.enabled is true |
- | FQDN and TLS Secrets for client endpoint. | Identifies the endpoint that enables the Cloud Manager, API Manager, and Developer Portal to communicate with the Analytics subsystem. |
| client.clientSubjectDN | string | only if client.enabled is true |
- | Subject DN (distinguished name) for authenticating with client endpoint (RFC 2253) | |
| client.style | carbon,bx |
no | carbon |
UI style for Analytics views | Setting to bx reverts the Analytics UI styles to the v2018 styles. Not
recommended. |
| client.rateLimitEnabled | boolean | no | false |
Enabled saved object creation rate limiting | Saved objects refer to dashboards, visualizations, and searches in the UI. This setting enforces a limit on how many can be created per provider organization. |
| client.rateLimitLimit | integer > 0 | no | 1000 |
Max limit of saved objects when enabled | See client.rateLimitEnabled. |
| client.basePath | string | no | /analytics |
Base path of the Analytics web server | Modifying this without modifying unexposed settings in the analytics-proxy causes errors. Not recommended. |
| client.clientAuthEnabled | boolean | no | true |
Whether to enable client auth | Changing this to false causes security issues with the Analytics service. Not recommended. |
| cronjobs.enabled | boolean | no | true |
Whether to deploy this microservice | This microservice manages indexes and data retention in storage. Only disable it if internal storage is also disabled. |
| cronjobs.retentionSchedule | string | no | 30 1 * * * |
Cron schedule for cj-retention cronjob |
This cronjob cleans up all indices older than the configured data retention age. If you need to run this more or less often based on your data retention settings, configure it here. |
| cronjobs.rolloverSchedule | string | no | 15,45 * * * * |
Cron schedule for cj-rollover cronjob |
This cronjob attempts to rollover the storage index. If you need to run this more or less often based on your index rollover settings, configure it here. |
| ingestion.enabled | boolean | no | true |
Whether to deploy this microservice | This microservice routes analytics data to internal or external storage. There is no supported topology of Analytics that disables this microservice. |
| ingestion.endpoint | object | if ingestion.enabled == true |
- | FQDN and TLS Secrets for client endpoint | Identifies the endpoint that enables the Gateway to push your analytics data. Must be
different from the client.endpoint |
| ingestion.clientSubjectDN | string | if ingestion.enabled == true |
- | Subject DN (distinguished name) for authenticating with ingestion endpoint (RFC 2253) | |
| ingestion.geoIPEnabled | boolean | no | false |
Whether to decorate API event data with geoip data | This populates the client_geoip and gateway_geoip fields using the IPs in client_ip and gateway_ip, respectively. |
| ingestion.filter | string | no | "" |
Filter to modify all API event data | See Modifying your analytics data for more information. |
| ingestion.pipelineWorkers | 4 <= integer <= 128 | no | 24 |
Number of pipeline workers | More workers means more CPU and memory requirements, but gives you the benefit of additional threads to pull data off the ingestion http interface and process it for storage. This has diminishing returns as the size increases, and should usually be multiple of the number of cores on your hardware. Adjust with caution. |
| ingestion.pipelineBatchSize | 10 <= integer <= 10000 | no | 250 |
Batch size of a pipeline worker | Pulling more or less data off the http interface per worker can have benefits. Ideally this
would limit impedance on match batches sent from the gateway, but that is not a proven result.
Recommended values are 125, 250, and 500.
Increasing the value requires more memory. Adjust with caution. |
| ingestion.pipelineBatchDelay | 10 <= integer <= 5000 | no | 50 |
Batch delay of a pipeline worker | How long to wait for the batch size to fill before leaving the http interface to process for storage. Having threads wait too long causes idle threads in your system; however, setting this value too low decreases performance. Adjust with caution. |
| ingestion.pipelineUnsafeShutdown | boolean | no | false |
Whether to allow unsafe shutdown of the pipeline | Typically, the pipeline attempts to empty all workers' batches before shutting down, to prevent data loss. You might need to enable this setting if the pipeline is badly configured and refuses to respond to kill requests (extremely uncommon). Adjust with caution. |
| ingestion.configReloadAutomatic | boolean | no | true |
Whether to automatically reload the pipeline on configuration changes | Typically, when the underlying files for the pipeline are modified, the pipeline process automatically reloads and picks up the changes. However, in Kubernetes environments where the pipeline is mapped to configmaps, this is unreliable. Ingestion microservice restarts are usually required. |
| ingestion.clientAuthEnabled | boolean | no | true |
Whether to enabled client auth | Setting this to false does not improve performance and makes Analytics extremely insecure. Not recommended at this time. |
| mq.enabled | boolean | no | false |
Whether to deploy these microservices | See Adding a message queue for more information. |
| mq.kafka.volumeClaimTemplate.storageClassName | string | no | default |
Storage class name | Name of the storage class configured to use for creating the microservice persistent volume. |
| mq.kafka.volumeClaimTemplate.volumeSize | string | no | 5Gi |
Volume size | Size of the volume used for kafka. See MQ storage: estimate disk space needs for more information. |
| mq.zk.volumeClaimTemplate.storageClassName | string | no | default |
Storage class name | nName of the storage class configured to use for creating the microservice persistent volume. |
| mq.zk.volumeClaimTemplate.volumeSize | string | no | 5Gi |
Volume size | Size of the volume used for zk. See MQ storage: estimate disk space needs for more information. |
| storage.enabled | boolean | no | true |
Whether to deploy this microservice | this microservice is used for storing and aggregating your data. only disable if you are only offloading and do not need internal storage |
| storage.type | unique,shared |
no | unique |
Type of storage deployment | See Reducing storage complexity for more information. |
| storage.coord.clientAuthEnabled | boolean | no | true |
Whether to enabled client auth | Setting this to false does not improve performance and makes Analytics extremely insecure. Not recommended. |
| storage.data.volumeClaimTemplate.storageClassName | string | no | default |
Storage class name | Name of the storage class configured to use for creating the microservice persistent volume |
| storage.data.volumeClaimTemplate.volumeSize | string | no | 50Gi |
Volume size | Size of the volume used for data storage. See Estimating internal storage space for more information. |
| storage.data.clientAuthEnabled | boolean | no | true |
Whether to enabled client auth | Setting this to false does not improve performance and makes Analytics extremely insecure. Not recommended. |
| storage.master.volumeClaimTemplate.storageClassName | string | no | default |
Storage class name | Name of the storage class configured to use for creating the microservice persistent volume. |
| storage.master.volumeClaimTemplate.volumeSize | string | no | 5Gi |
Volume size | Size of the volume used for data storage. See Estimating internal storage space for more information. |
| storage.master.clientAuthEnabled | boolean | no | true |
Whether to enabled client auth | Setting this to false does not improve performance and makes Analytics extremely insecure. Not recommended. |
| storage.shared.volumeClaimTemplate.storageClassName | string | no | default |
Storage class name | Name of the storage class configured to use for creating the microservice persistent volume |
| storage.shared.volumeClaimTemplate.volumeSize | string | no | 50Gi |
Volume size | Size of the volume used for data storage. See Estimating internal storage space for more information. |
| storage.shared.clientAuthEnabled | boolean | no | true |
Whether to enabled client auth | Setting this to false does not improve performance and makes Analytics extremely insecure. Not recommended. |
| external.offload.enabled | boolean | no | false |
Whether to enable this integration | See Offloading data to a third-party system for more information. |
| external.offload.filter | string | no | "" |
Filter configuration for external offload | See Offloading data to a third-party system for more information. |
| external.offload.output | string | no | "" |
Output configuration for external offload | See Offloading data to a third-party system for more information. |
| external.offload.secretName | string | no | "" |
Name of secret for mounting files to use in external offload configuration | See Offloading data to a third-party system for more information. |
| databaseBackup.host | string | no | "" |
The URL to your S3 storage. | See Configuring backup settings for Analytics |
| databaseBackup.path | string | no | "" |
The path to your S3 storage at the URL specified by
databaseBackup.host |
See Configuring backup settings for Analytics |
| databaseBackup.schedule | string | no | Specifies the frequency of automatic backups, using any valid cron
string. |
See Configuring backup settings for Analytics | |
| databaseBackup.credentials | string | no | "" |
The name of the secret used for authenticating with your S3 storage | See Configuring backup settings for Analytics |
| databaseBackup.enableCompression | boolean | no | true |
See Configuring backup settings for Analytics | |
| databaseBackup.chunkSize | string | no | 1Gi |
See Configuring backup settings for Analytics | |
| databaseBackup.enableServerSideEncryption | boolean | no | See Configuring backup settings for Analytics |