summaryrefslogtreecommitdiff
path: root/www-apps/trickster/files/trickster.conf
blob: 9fb255e19c5bca228692020e34d7131ab06a3071 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
[main]
# instance_id allows you to run multiple trickster processes on the same host and log to separate files
# Useful for baremetal, not so much for elastic deployments, so only uncomment if you really need it
#instance_id = 1

# Configuration options for the Proxy Server
[proxy_server]
# listen_port defines the port on which Trickster's Proxy server listens.
# since this is a proxy for Prometheus, we use 9090 by default, just like Prometheus does
# listen_port = 9090
# listen_address defines the ip on which Trickster's Proxy server listens.
# empty by default, listening on all interfaces
# listen_address =

[cache]
# cache_type defines what kind of cache Trickster uses
# options are 'boltdb', 'filesystem', 'memory', and 'redis'.
# The default is 'memory'.
cache_type = 'memory'

# record_ttl_secs defines the relative expiration of cached queries. default is 6 hours (21600 seconds)
# record_ttl_secs = 21600

# reap_sleep_ms defines how long the cache reaper waits between reap cycles. Default is 1000 (1s)
# reap_sleep_ms = 1000

# compression determines whether the cache should be compressed. default is true
# compression = true

    ### Configuration options when using a Redis Cache
    # [cache.redis]
    # protocol defines the protocol for connecting to redis ('unix' or 'tcp') 'tcp' is default
    # protocol = 'tcp'
    # endpoint defines the fqdn+port or path to a unix socket file for connecting to redis
    # default is 'redis:6379' 
    # endpoint = 'redis:6379'

    ### Configuration options when using a Filesystem Cache
    # [cache.filesystem]
    # cache_path defines the directory location under which the Trickster cache will be maintained
    # default is '/tmp/trickster'
    # cache_path = '/tmp/trickster'

    # Configuration options when using a BoltDb Cache
    #[cache.boltdb]

    # filename defines the file where the Trickster cache will be maintained
    # default is 'trickster.db'
    # filename = 'trickster.db'

    # bucket defines the name of the BotlDb bucket (similar to a namespace) under which our key value store lives
    # default is 'trickster'
    # bucket = 'trickster'

# Configuration options for mapping Origin(s)
[origins]
    ### The default origin
    [origins.default]

    # origin_url defines the URL of the origin. Default is http://prometheus:9090
    origin_url = 'http://prometheus:9090'

    # timeout_secs defines how many seconds Trickster will wait before aborting and upstream http request. Default: 180s
    # timeout_secs = 180

    # api path defines the path of the Prometheus API (usually '/api/v1')
    api_path = '/api/v1'

    # ignore_no_cache_header disables a client's ability to send a no-cache to refresh a cached query. Default is false 
    # ignore_no_cache_header = false

    # max_value_age_secs defines the maximum age of specific datapoints in seconds. Default is 86400 (24 hours)
    max_value_age_secs = 86400

    # fast_forward_disable, when set to true, will turn off the 'fast forward' feature for any requests proxied to this origin
    # fast_forward_disable = false

    # For multi-origin support, origins are named, and the name is the second word of the configuration section name.
    # In this example, an origin is named "foo". Clients can indicate this origin in their path (http://trickster.example.com:9090/foo/query_range?.....)
    # there are other ways for clients to indicate which origin to use in a multi-origin setup. See the documentation for more information

    # [origins.foo]
    # origin_url = 'http://prometheus-foo:9090'
    # api_path = '/api/v1'
    # default_step = 300
    # ignore_no_cache_header = false
    # max_value_age_secs = 86400
    # timeout_secs = 180

# Configuration Options for Metrics Instrumentation
[metrics]
# listen_port defines the port that Trickster's metrics server listens on at /metrics
listen_port = 8082
# listen_address defines the ip that Trickster's metrics server listens on at /metrics
# empty by default, listening on all interfaces
# listen_address =

# Configruation Options for Profiler
[profiler]
# enabled indicates whether to start the profiler server when Trickster starts up. Default: false 
# enabled = false
# listen_port defines the port that Trickster's profiler server listens on at /debug/pprof. Default: 6060
# listen_port = 6060

# Configuration Options for Logging Instrumentation
[logging]
# log_level defines the verbosity of the logger. Possible values are 'debug', 'info', 'warn', 'error'
# default is info
log_level = 'info'

# log_file defines the file location to store logs. These will be auto-rolled and maintained for you.
# not specifying a log_file (this is the default behavior) will print logs to STDOUT
log_file = '/var/log/trickster/trickster.log'