Analytics CR properties reference

List of all the properties that can be configured in the analytics CR.

Note: If you have a VMware deployment, do not edit the analytics CR directly. Use the apicup command and analytics-extra-values.yaml file. See Analytics extra-values file.
The following properties must be defined in your analytics CR:
  • ingestion.endpoint
  • ingestion.clientSubjectDN
All other properties are optional.
Note: If you are using Cloud Pak for Integration or the top-level CR on OpenShift, then configure your analytics properties in the analytics section of the top-level CR. Do not edit the analytics CR directly. If the properties you want to set are missing from the top-level CR, then copy them from the analytics CR to the top-level CR.
Table 1. Analytics subsystem CR properties.
Property Type Default value Description Comments 
allowUpgrade
 Boolean false Legacy property for upgrade to v10.0 5 from previous releases. The allowUpgrade property is not used in v10.0.6 and can be deleted from the analytics CR. 
databaseBackup:
  host
 String   The URL to your S3 object store. See Backup, restore, and disaster recovery. 
databaseBackup:
  path
 String   The path to your S3 object store at the URL specified by databaseBackup.host. See Backup, restore, and disaster recovery. 
databaseBackup:
  schedule
 String   Specifies the frequency of automatic backups. Use any valid cron string. See Backup, restore, and disaster recovery. 
databaseBackup:
  enableCompression
 Boolean true Specifies whether to compress the backups. See Backup, restore, and disaster recovery. 
databaseBackup:
  credentials
 String   The name of your S3 object store authentication secret. See Backup, restore, and disaster recovery. 
databaseBackup:
  backupCerts
 String   The name of the secret that contains your S3 server certificate. See Backup, restore, and disaster recovery. 
databaseBackup:
  chunkSize
 String 1gb Specifies the size of large file chunks. Format is lower case and no spaces, for example: 1gb, 50mb, 800kb. See Backup, restore, and disaster recovery. 
databaseBackup:
  enableServerSideEncryption
 Boolean true Specifies whether metadata files are stored in compressed format. See Backup, restore, and disaster recovery. 
external:
  offload:
    filter
 String   Filter configuration for external offload. See Offload to third-party systems. 
external:
  offload:
    enabled
 Boolean false Enables analytics offload feature. See Offload to third-party systems. 
external:
  offload:
    output
 String   Output configuration for external offload. See Offload to third-party systems. 
external:
  offload:
    passwordSecretName
 String   The name of the secret that has the password to access the certificate keystore. See Offload to third-party systems. 
external:
  offload:
    secretName
 String   The name of the secret that contains the certificate that is used for connecting to the offload target. See Offload to third-party systems. 
ingestion:
  endpoint
 Object   FQDN and TLS Secrets for client endpoint. The external endpoint of the analytics subsystem. Both the gateway and management subsystems use the ingestion endpoint to communicate with your analytics subsystem. The gateway sends API event data to the ingestion endpoint. 
ingestion:
  clientSubjectDN
 String   Subject DN (distinguished name) for authenticating with ingestion endpoint (RFC 2253).   
ingestion:
  filter
 String   Filter to modify API event data before it is sent for local storage (not offloaded). See Customizing data with ingestion filters. 
ingestion:
  geoIPEnabled
 Boolean true Include the client_geoip and gateway_geoip fields in your API event records. Applies to both locally stored and offloaded data. 
ingestion:
  queue
 Object   Persistent queue settings. See Logstash persistent queue. 
ingestion:
  queue:
    type
 String   Persistent queue settings. Default is persisted. Set to memory if you want to disable the persistent queue. See Logstash persistent queue. 
ingestion:
  queue:
    volumeClaimTemplate:
      volumeSize
 String   Storage size for your persistent queue. Default is 50Gi. Do not change this value. See Logstash persistent queue. 
ingestion:
  queue:
    volumeClaimTemplate:
      storageClassName
 String   Storage class name for your persistent storage. See Logstash persistent queue. 
ingestion:
  pipelineWorkers
 4 <= integer <= 128 24 Number of pipeline workers. See Performance tuning with ingestion pipeline properties. 
ingestion:
  pipelineBatchSize
 10 <= integer <= 10000 250 Batch size of a pipeline worker. See Performance tuning with ingestion pipeline properties. 
ingestion:
  pipelineBatchDelay
 10 <= integer <= 5000 50 Batch delay of a pipeline worker. See Performance tuning with ingestion pipeline properties. 
ingestion:
  configReloadAutomatic
 Boolean true Whether to automatically reload the pipeline on configuration changes. See Performance tuning with ingestion pipeline properties. 
ingestion:
  pipelineUnsafeShutdown
 Boolean false Whether to allow unsafe shutdown of the pipeline. See Performance tuning with ingestion pipeline properties. 
longTermDataEnabled
 Boolean true Enables the collection of long-term summary data that is required for reports and leaderboards. If you set longTermDataEnabled to false, no long-term summary data is generated, however the oscron job still runs. Long-term summary data is only generated when local storage is not disabled. 
standaloneCluster
 Boolean false Legacy property related to Zen endpoints. The standaloneCluster property is not used in v10.0.6 and can be deleted from the analytics CR. 
storage:
  type
 String shared Type of storage deployment. Shared or dedicated. See Storage type. 
storage:
  shared:
    volumeClaimTemplate:
      storageClassName
 String cluster default Storage class name. Name of the storage class for your analytics data. See Storage class. 
storage:
  shared:
    volumeClaimTemplate:
      volumeSize
 String 50Gi Volume size. Size of the volume used for data storage. See Estimating storage requirements.