Pilosa can be configured through command line flags, environment variables, and/or a configuration file; configured options take precedence in that order. So if an option is specified in a command line flag, it will take precedence over the same option specified in the environment, which would take precedence over that same option specified in the configuration file.
All options are available in all three configuration types with the exception of the
--config option which specifies the location of the config file, and therefore will not be used if it is present in the config file.
The syntax for each option is slightly different between each of the configuration types, but follows a simple formula. See the following three sections for an explanation of each configuration type.
Command line flags
Pilosa uses GNU/POSIX style flags. Most flags you specify as
--flagname=value although some have a short form that is a single character and can be specified with a single dash like
-f value. Running
pilosa server --help will give an overview of the available flags as well as their short forms (if applicable).
Every command line flag has a corresponding environment variable. The environment variable is the flag name in all caps, prefxed by
PILOSA_, and with any dashes replaced by underscores. For example:
The config file is in the toml format and has exactly the same options available as the flags and environment variables. Any flag which contains a dot (“.”) denotes nesting within the config file, so the two flags
--cluster.replicas=1 look like this in the config file:
[cluster] poll-interval = "2m0s" replicas = 1
Any flag that has a value that is a comma separated list on the command line becomes an array in toml. For example
[cluster] hosts = ["one.pilosa.com:10101", "two.pilosa.com:10101"]
Anti Entropy Interval
- Description: Interval at which the cluster will run its anti-entropy routine which makes sure that all replicas of each fragment are in sync.
[anti-entropy] interval = "10m0s"
- Description: host:port on which the Pilosa server will listen for requests. Host defaults to localhost and port to 10101.
bind = localhost:10101
- Description: Port to which Pilosa should bind for internal communication.
internal-port = 11101
- Description: List of hosts in the cluster. Multiple hosts should be comma separated in the flag and env forms.
[cluster] hosts = ["localhost:10101"]
Cluster Internal Hosts
- Description: List of hosts in the cluster used for internal communication. Multiple hosts should be comma separated in the flag and env forms.
[cluster] internal-hosts = ["localhost:11101"]
Cluster Poll Interval
- Description: Polling interval for cluster.
[cluster] poll-interval = "1m0s"
- Description: Number of hosts each piece of data should be stored on.
[cluster] replicas = 1
- Description: Determine how the cluster handles membership and state sharing. Choose from [static, http, gossip].
- static - Messaging between nodes is disabled. This is primarily used for testing.
- http - Messages are transmitted over HTTP.
- gossip - Messages are transmitted over TCP. Cluster status and node state are kept in sync via internode gossip.
[cluster] type = "gossip"
- Description: Directory to store Pilosa data files.
data-dir = "~/.pilosa"
- Description: When using the gossip Cluster Type, this specifies which internal host should be used to initialize membership in the cluster. Typcially this can be the address of any available host in the cluster. For example, when starting a three-node cluster made up of
gossip-seedfor all three nodes can be configured to be the address of
[cluster] type = "gossip" gossip-seed = "localhost:11101"
- Description: If this is set to a path, collect a cpu profile and store it there.
[profile] cpu = "/path/to/somewhere"
Profile CPU Time
- Description: Amount of time to collect cpu profiling data if
- Env: `PILOSA_PROFILE.CPU_TIME=“30s”
[profile] cpu-time = "30s"
Description: Which stats service to use (StatsD or ExpVar).
[metric] service = “statsd”
- Description: Address of the StatsD service host.
- Env: `PILOSA_METRIC.HOST=localhost:8125’
[metric] host = "localhost:8125"
Metric Poll Interval
- Description: Polling interval for runtime metrics.
[metric] poll-interval = "0m15s"