Categories:
Aura KPIs Uploader environment variables
List of environment variables handled by Aura KPIs uploader
- Properties marked in bold are mandatory.
- Properties marked in italics are optional.
| Property | Type | Description | Modifiable by OB? |
|---|---|---|---|
| AURA_AUTHORIZATION_HEADER | string | Complete authorization header to be sent to AURA_CHANNELS_CONFIGURATION_API_ENDPOINT, with the following format: APIKEY xxxxxx |
YES, but only if the previous APIKey was deprecated |
| AURA_CHANNELS_CONFIGURATION_API_ENDPOINT | string | Complete URL where aura-bot should get the configuration of all the channels available in the environment. | YES, but only if the generated SAS token was deprecated. |
| AURA_DAYS_INTERVAL | number | Interval of days to get the processed KPIs files. By default: 30 |
NO |
| AURA_DEFAULT_LOCALE | string | Culture code to be used by default in the current deployment: de-de, en-gb, es-es, pt-br. |
NO |
| AURA_ENVIRONMENT_NAME | string | Name of the environment where aura-kpis-uploader is deployed. For example: ap-next, es-dev, de-pre |
NO |
| AURA_FILES_PREFIX | string | Paths where aura-bot, aura-nlp or aura-authentication-api entity KPIs files are stored. | NO |
| AURA_FOLDER_DESTINATION | string | Root folder name in destination where the KPIs files are stored. By default: AURA_DATA. |
NO |
| AURA_KPIS_ENTITIES_CONTAINER | string | Name of the Azure Blob container to store Aura entities files. By default, aura-kpis. It MUST be the same than the AURA_KPIS_STORE_CONTAINER configured in aura-bot, aura-authentication-api, aura-kpis and aura-nlp. |
NO |
| AURA_KPI_FILES_EXTENSION | string | Extension to be used in KPIs files. Default: txt. It MUST be the same than the AURA_KPI_TO_DSV_EXTENSION configured in aura-bot, aura-authentication-api, aura-kpis and aura-nlp. |
NO |
| AURA_KPI_FILES_NOT_TO_UPLOAD | string | String separated by comma with the files to not upload to the destination folder with format Component:Entity. For example: BOT:MESSAGE,BOT:API |
NO |
| AURA_KPIS_TIME_FILE_IS_IN_USE_AMOUNT | number | Contains the amount of time it considers a file to be in use and does not process it. By default: 1 |
|
| AURA_KPIS_TIME_FILE_IS_IN_USE_UNIT | string | Time unit that together with AURA_KPIS_TIME_FILE_IS_IN_USE_AMOUNT determines whether or not a file should be processed: Values: “year”, “years”, “y”, “month”, “months”, “M”, “week”, “weeks”, “w”, “day”, “days”, “d”, “hour”, “hours”, “h”, “minute”, “minutes”, “m”. By default: hour |
|
| AURA_LOGGING_FORMAT | string | Format to be used in monitoring logs: json or dev (which is a more visual format). By default: json. |
NO. Only for development, set it to dev. |
| AURA_LOGGING_LEVEL | string | Level to be used in monitoring logs, from more to less verbose: 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'OFF'. By default: 'INFO'. |
YES, for development environment, set it to debug. In pre/production environment, it should be ‘INFO’ or ‘ERROR’. For analysis of an issue in pre/production, it may be changed to ‘DEBUG’. |
| AURA_MICROSOFT_AZURE_STORAGE_COMMON_ACCESS_KEY | string | Microsoft Storage password of the source deployment. | NO. Only if Operations Team changes it. |
| AURA_MICROSOFT_AZURE_STORAGE_COMMON_ACCOUNT | string | Microsoft Storage account of the source environment. | NO. Only if Operations Team changes it. |
| AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY_DESTINATION | string | Microsoft Storage password of destination. | NO |
| AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT_DESTINATION | string | Microsoft Storage account of destination. | NO |
| AURA_MICROSOFT_AZURE_STORAGE_CONTAINER_DESTINATION | string | Microsoft Storage container of destination. | NO |
| AURA_VERSION | string | Number of Aura release being executed. | NO |
| PUSHGATEWAY_ENDPOINT | string | Prometheus push gateway endpoint. | NO |
| PROMETHEUS_JOB_NAME | string | Prometheus job name. By default: aura_kpi_uploader_job. |
NO |
| AURA_SOURCE_PATH_AVRO_ADAPTERS | string | Relative path to file with the dimensions and entities to transform Avro. | NO |
| AURA_KPIS_AVRO_DESTINATION_PATH | string | Path to store the Avro files in Aura Azure Container. Default: ‘avro’ | YES |
| AURA_KPIS_REPORTS_DESTINATION_PATH | string | Path to store the reports in Aura Azure Container. Default: ‘reports’ | YES |
| AURA_KPIS_REPORTS_MODE | string | Behavior of aura-kpis-uploader regarding the generation of reports. Possible values: all: a report is generated for each processed file; none: it will not generate any report; error: it generates a report if an error has occurred. By default: error. |
NO |
| AURA_SOURCE_PATH_AVRO_ADAPTERS | string | Adapters to transform data, ‘/schemas/aura-csv-adapter.json’ for CSV transform and ‘/schemas/aura-avro-adapter.json’ to transform in CSV and Avro. By default: schemas/aura-csv-adapter.json. |
YES |
| AURA_SAS_STORAGE_FILE_TTL | number | TTL in minutes for SAS when generates URL to File Storage. By default: 15. |
YES |
| AURA_KPIS_BLOB_TIME_WAIT_IF_EXISTS | number | Time to wait in milliseconds if the KPIs blob exists to avoid duplicate headers. By default: 1000. |
YES |
| AURA_KPIS_REPORTS_SAS_EXPIRATION | number | Time to expiration in minutes for the report SAS URL generated when an error occurs. Default: 43200 (30 days). |
YES |
| AURA_DATABRICKS_OK_FILENAME | string | Name of the file to validate if DataBricks process was successful. Inside the file, there is a date to validate last success execution. Default: databricks.OK |
YES |
| AURA_DATABRICKS_ERROR_FILENAME | string | Name of the file to validate if DataBricks process was failed. Default: databricks.ERROR |
YES |
| AURA_DATABRICKS_EXECUTION_PERIOD | number | Period of DataBricks execution in hours. By default: 24. |
YES |
| AURA_KPIS_AVRO_SIZE_REPORT_FILENAME | string | Contains the name of the file to store size of AVRO files. By default: sizeReport.json. |
YES |
| AURA_KPI_MAX_BLOCK_SIZE_FOR_APPEND_BLOB | number | Maximum buffer size for append blob uploading. Default: 100000000 (100MiB) |
YES. It can be changed by a value lower than the maximum one established by default |
| AURA_KPI_NUM_MAX_FILES_FOR_EXECUTION | number | Number of files by entity to process in a single execution. Default: 12 |
YES |
| AURA_KPI_HOURS_TO_SUBTRACT_TO_GET_NUM_MAX_FILES | number | Number of hours to subtract in order to get the number of files to process in a single execution. Default: 10 |
YES |
Last modified November 11, 2025: feat: Clean up of Living Apps related stuff #AURA-30761 [RTM] (c97ca748)