Add query config docs (#1464)

docs/query_engine/config/annotated_config.md

@@ -0,0 +1,3 @@
+# Annotated Config
+
+Please [see here](./annotated_config.yaml) for a link to the annotated config.

docs/query_engine/config/annotated_config.yaml

@@ -0,0 +1,86 @@
+listenAddress:
+  type: "config"
+  value: "0.0.0.0:7201"
+
+# metrics configuration
+metrics:
+  scope:
+    prefix: "coordinator"
+  prometheus:
+    handlerPath: /metrics
+    listenAddress: 0.0.0.0:7203 # until https://github.com/m3db/m3/issues/682 is resolved
+  sanitization: prometheus
+  samplingRate: 1.0
+  extended: none
+
+clusters:
+  - namespaces:
+      - namespace: default
+        type: unaggregated
+        retention: 48h
+    client:
+      config:
+        service:
+          env: default_env
+          zone: embedded
+          service: m3db
+          cacheDir: /var/lib/m3kv
+          etcdClusters:
+            - zone: embedded
+              endpoints:
+                - 127.0.0.1:2379
+        seedNodes:
+          initialCluster:
+            - hostID: m3db_local
+              endpoint: http://127.0.0.1:2380
+      writeConsistencyLevel: majority
+      readConsistencyLevel: unstrict_majority
+      writeTimeout: <duration>
+      # fetchTimeout defines the fetch timeout for any given query.
+      # The default is 30s and the max is 5m.
+      fetchTimeout: <duration>
+      connectTimeout: 20s
+      writeRetry:
+        initialBackoff: 500ms
+        backoffFactor: 3
+        maxRetries: 2
+        jitter: true
+      fetchRetry:
+        initialBackoff: 500ms
+        backoffFactor: 2
+        maxRetries: 3
+        jitter: true
+      backgroundHealthCheckFailLimit: 4
+      backgroundHealthCheckFailThrottleFactor: 0.5
+
+readWorkerPoolPolicy:
+  grow: <bool>
+  size: <int>
+
+writeWorkerPoolPolicy:
+  grow: <bool>
+  size: <int>
+
+tagOptions:
+  # See here for more information: http://m3db.github.io/m3/how_to/query/#id-generation
+  idScheme: <id_scheme>
+
+cache:
+  # See here for more information: http://m3db.github.io/m3/performance/m3query/
+  queryConversion:
+    size: <int>
+
+# lookbackDuration defines, at each step, how long we lookback until we see a non-NaN value.
+# If not set, we default to 5m, which matches Prometheus.
+lookbackDuration: <duration>
+
+# ResultOptions are the result options for query.
+resultOptions:
+  #	KeepNans keeps NaNs before returning query results.
+  # The default is false, which matches Prometheus
+  keepNans: <bool>
+
+# Enables local jaeger tracing. See https://www.jaegertracing.io/docs/1.9/getting-started/
+# for quick local setup (which this config will send data to).
+tracing:
+  backend: jaeger

mkdocs.yml

@@ -60,6 +60,8 @@ pages:
       - "Overview": "query_engine/architecture/index.md"
       - "Blocks": "query_engine/architecture/blocks.md"
       - "Function Processing": "query_engine/architecture/functions.md"
+    - "Configuration":
+      - "Annotated Config File": "query_engine/config/annotated_config.md"
   - "How-To's":
     - "M3DB Single Node Deployment": "how_to/single_node.md"
     - "M3DB Cluster Deployment, Manually": "how_to/cluster_hard_way.md"