Skip to content
This repository was archived by the owner on Nov 21, 2022. It is now read-only.

Commit 2e0854d

Browse files
author
Archit Sharma
committed
update inline doc of config file; fix README conf ref
1 parent fd8c9ae commit 2e0854d

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ If you think it's a bug, you're welcome to open an issue here on github.
8888
### Additional Note
8989

9090
- Below mentioned ports will be used for port mapping from container to host, and
91-
could be configured in `sarjitsu.conf`. Default bindings are:
91+
could be configured in `conf/sarjitsu.conf`. Default bindings are:
9292

9393
```sh
9494
METRICSTORE_PORT_MAPPING=9600

conf/sarjitsu.conf

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@
1010
###########################################################
1111
# metricstore config (postgres) - for grafana's metadata
1212
DB_HOST=
13-
# append DB_PORT in grafana.ini db config
1413
DB_NAME=grafana
1514
DB_USER=grafana
1615
DB_PASSWORD=sarjitsu123
17-
DB_PORT=5432 # default for postgres
16+
DB_PORT=5432
1817

18+
# TODO: data dir option below is currently not integrated into sarjitsu;
19+
# one would have to build a postgres container, to make new mountpoint
20+
# available. Refer to https://hub.docker.com/_/postgres/ for more.
21+
# set to default
1922
DB_DATA_DIR='/var/lib/postgresql/data'
2023
# change this in production, if you have a fs mountpoint (for persistent disks)
2124
# if so, you'll have to build the postgres container (and not just pull it
@@ -25,13 +28,17 @@ DB_DATA_DIR='/var/lib/postgresql/data'
2528
# datasource config (elasticsearch) - source of timeseries data
2629
ES_HOST=
2730
ES_PORT=9200
31+
32+
# sarjitsu currently needs passwordless access to elasticsearch;
33+
# this protocol goes into grafana's datasource settings.
2834
ES_PROTOCOL=http
2935

3036
# set this if you want a particular cluster name while building
3137
# the ElasticSearch container. If not set, a random string will be assigned
3238
ES_CLUSTER_NAME=elasticsearch$RANDOM
3339

34-
# below settings are for data sent to ES by backend and middleware
40+
# below settings are for data sent to ES by backend and middleware;
41+
# recommended to keep these values to default.
3542
INDEX_PREFIX=sarjitsu
3643
BULK_ACTION_COUNT=2000
3744
INDEX_VERSION=1
@@ -46,14 +53,24 @@ GRAFANA_DB_TYPE=postgres
4653
# make sure this is above 1024; 3000 is standard
4754
GRAFANA_PORT=3000
4855

56+
# Sarjitsu supports only ES < 2.0 ..which supports _timestamp
57+
# in mapping. If you don't have a production instance of ES<2.0
58+
# it is highly recommended to leave ES_HOST option empty to let
59+
# sarjitsu spawn it's own compatible instance of ElasticSearch
4960
GRAFANA_TIMEFIELD=_timestamp
61+
62+
# you could change these
5063
GRAFANA_DS_NAME=elastic
64+
65+
# don't change this. It is here for reference of app itself
5166
GRAFANA_DS_PATTERN=[$INDEX_PREFIX.sar-]YYYYMMDD
5267

5368
###########################################################
5469
# middleware config (frontend API server) - service that builds dashboards
5570
MIDDLEWARE_HOST=
5671
MIDDLEWARE_PORT=80
72+
73+
# don't change this. It is here for reference of app itself
5774
MIDDLEWARE_ENDPOINT=/db/create/
5875

5976
###########################################################

0 commit comments

Comments
 (0)