Basic Configuration

To configure Humio’s basic functionality, you’ll set environment variables. The example configuration file below contains the environment variables you’ll typically need to include.

Docker Tip

When running Humio in Docker, you can pass set the --env-file= flag and keep your configuration in a file. For a quick introduction to setting configuration options, see running Humio as a Docker container.

Docker only loads the environment file when the container is initially created. If you make changes to the settings in your environment file, simply stopping and starting the container will not work. You need to docker rm the container and docker run it again to pick up changes.

HUMIO_JVM_ARGS=-Xss2M --add-exports java.base/jdk.internal.util=ALL-UNNAMED -XX:CompileCommand=dontinline,com/humio/util/HotspotUtilsJ.dontInline

BACKUP_NAME=my-backup-name
BACKUP_DIR="/backup"
BACKUP_KEY=my-secret-key-used-for-encryption
DELETE_BACKUP_AFTER_MILLIS=604800000

BOOTSTRAP_HOST_ID=1
# BOOTSTRAP_HOST_UUID_COOKIE

# ZOOKEEPER_URL_FOR_NODE_UUID=host1:2181,host2:2181,host3:2181
# ZOOKEEPER_PREFIX_FOR_NODE_UUID=/humio_autouuid_

EXTERNAL_URL=https://humio01.example.com
PUBLIC_URL=https://humio.mycompany.com

IDLE_POLL_TIME_BEFORE_DASHBOARD_QUERY_IS_CANCELLED_MINUTES=4320
WARN_ON_INGEST_DELAY_MILLIS=30000
INGEST_QUEUE_REPLICATION_FACTOR=2

KAFKA_SERVERS=kafkahost01:9092,kafkahost02:9092
KAFKA_MANAGED_BY_HUMIO=true
DELETE_ON_INGEST_QUEUE=true
EXTRA_KAFKA_CONFIGS_FILE=extra_kafka_properties.properties
HUMIO_KAFKA_TOPIC_PREFIX=
ZOOKEEPER_URL=localhost:2181

MAX_DATASOURCES=10000

COMPRESSION_TYPE=high
COMPRESSION_LEVEL=9
COMPRESSION_LEVEL_MINI=0

#VALUE_DEDUP_LEVEL=COMPRESSION_LEVEL
MAX_HOURS_SEGMENT_OPEN=24
FLUSH_BLOCK_SECONDS=1800
BLOCKS_PER_SEGMENT=8000
#BLOCKS_PER_MINISEGMENT=128
#BLOCK_SIZE_MIN_KB=384
#BLOCK_SIZE_MAX_KB=1024
#HASHFILTER_FILL=30
NODE_ROLES=all
#QUERY_COORDINATOR=true
#ENABLE_QUERY_LOAD_BALANCING=true
#SHUTDOWN_ABORT_FLUSH_TIMEOUT_MILLIS=300000

# GC_KILL_FACTOR=1.0
# GC_KILL_THRESHOLD_MILLIS=60000

POSTMARK_SERVER_SECRET=abc2454232
POSTMARK_FROM=Humio <humio@example.com>

#SMTP_HOST=smtp.gmail.com
#SMTP_PORT=587
#SMTP_SENDER_ADDRESS=you@domain.com
#SMTP_USE_STARTTLS=true
#SMTP_USERNAME=you@domain.com
#SMTP_PASSWORD=your-secret-password

SMTP_HOST=localhost
SMTP_PORT=25
SMTP_SENDER_ADDRESS=you@domain.com
SMTP_USE_STARTTLS=false

HTTP_PROXY_HOST=proxy.myorganisation.com
HTTP_PROXY_PORT=3129
HTTP_PROXY_USERNAME=you
HTTP_PROXY_PASSWORD=your-secret-password

# HTTP_PROXY_ALLOW_NOTIFIERS_NOT_USE=true
# IP_FILTER_NOTIFIERS=allow 192.168.0.16

HUMIO_PORT=8080
ELASTIC_PORT=9200
PROMETHEUS_METRICS_PORT=8081
HUMIO_SOCKET_BIND=0.0.0.0

HUMIO_HTTP_BIND=0.0.0.0
#VERIFY_CRC32_ON_SEGMENT_FILES=true

S3_ARCHIVING_ACCESSKEY=$ACCESS_KEY
S3_ARCHIVING_SECRETKEY=$SECRET_KEY
# S3_ARCHIVING_ENDPOINT_BASE=http://my-own-s3:8080
S3_ARCHIVING_WORKERCOUNT=1

# S3_ARCHIVING_USE_HTTP_PROXY=false

S3_STORAGE_ACCESSKEY=$ACCESS_KEY
S3_STORAGE_SECRETKEY=$SECRET_KEY

# AWS_ACCESS_KEY_ID=$ACCESS_KEY
# AWS_SECRET_ACCESS_KEY=$SECRET_KEY

S3_STORAGE_ENDPOINT_BASE=http://my-own-s3:8080
S3_STORAGE_WORKERCOUNT=1
S3_STORAGE_BUCKET=$BUCKET_NAME
S3_STORAGE_REGION=$BUCKET_REGION
S3_STORAGE_ENCRYPTION_KEY=$ENCRYPTION_SECRET
# S3_STORAGE_OBJECT_KEY_PREFIX=/basefolder

# S3_STORAGE_USE_HTTP_PROXY=false

S3_STORAGE_CHUNK_SIZE=8388608
S3_STORAGE_CHUNK_COUNT=4
S3_STORAGE_UPLOAD_CONCURRENCY=vcores/2
S3_STORAGE_DOWNLOAD_CONCURRENCY=vcores/2

# USING_EPHEMERAL_DISKS=false
LOCAL_STORAGE_PERCENTAGE=80
LOCAL_STORAGE_MIN_AGE_DAYS=0

# SHARED_DASHBOARDS_ENABLED=false

AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=false
AUTO_UPDATE_GROUP_MEMBERSHIPS_ON_SUCCESSFUL_LOGIN=false
ONLY_CREATE_USER_IF_SYNCED_GROUPS_HAVE_ACCESS=false

DEFAULT_GROUPS=group1, group2
# ENABLE_PERSONAL_API_TOKENS = true
DEFAULT_PARTITION_COUNT=24
INGEST_QUEUE_INITIAL_PARTITIONS=24
MAX_INGEST_DELAY_SECONDS=3600

# LIVEQUERY_CANCEL_TRIGGER_DELAY_MS=60000
# LIVEQUERY_CANCEL_COST_PERCENTAGE=10
# LIVEQUERY_STALE_CANCEL_TRIGGER_DELAY_MS=20000
# LIVEQUERY_STALE_CANCEL_COST_PERCENTAGE=10
MAX_STATE_LIMIT=20000

MAX_SERIES_LIMIT=50
MAX_SERIES_MEMLIMIT=1KiB
MAX_FILEUPLOAD_SIZE=104857600
EXACT_MATCH_LIMIT=1000000
MAX_BUCKET_POINTS=10000

SECONDARY_DATA_DIRECTORY=/secondaryMountPoint/humio-data2
PRIMARY_STORAGE_PERCENTAGE=80
PRIMARY_STORAGE_MAX_FILL_PERCENTAGE=95
SECODARY_STORAGE_MAX_FILL_PERCENTAGE=95
CACHE_STORAGE_DIRECTORY=/humio-cache
CACHE_STORAGE_PERCENTAGE=90

DUMP_THREADS_SECONDS=10
STREAMING_QUERY_KEEPALIVE_NEWLINES=false
STREAMING_QUERY_KEEPALIVE_NEWLINES_ON_NODES=false
STREAMING_QUERY_KEEPALIVE_TIMEOUT=10
MAX_CHARS_TO_FIND_TIMESTAMP=128

AUTO_UPDATE_IP_LOCATION_DB=true

MAXMIND_ACCOUNT_ID=your-account-id
MAXMIND_LICENSE_KEY=your-license-key
MAXMIND_EDITION_ID=GeoLite2-City
MAXMIND_BASE_URL=http://my-maxmind-proxy.local

#ZONE=dc1
#DIGEST_REPLICATION_FACTOR=2
#STORAGE_REPLICATION_FACTOR=2

MAX_NUMBER_OF_GLOBALDATA_DUMPS_TO_KEEP=20
ENABLE_ALERTS=true
ALERT_MAX_THROTTLE_FIELD_VALUES_STORED=100

ALERT_DESPITE_WARNINGS=false