feat: add loki to docker-compose (#639)

Author: MegaRedHand

.gitignore

@@ -44,19 +44,20 @@ priv
 .vscode/
 
 # spec-test vectors
-test/spec/vectors
+/test/spec/vectors
 
-native/libp2p_port/libp2p_port
+/native/libp2p_port/libp2p_port
 
 # Proto generated code.
 *.pb.ex
 *.pb.go
 
 # local db.
-level_db
+/level_db
+/logs
 
 # Generated tests
-test/generated
+/test/generated
 
 # profiling artifacts
 callgrind.out.*

config/config.exs

@@ -4,6 +4,18 @@ import Config
 # Configure logging
 config :logger, level: :info, truncate: :infinity
 
+## TODO: we might want to enable this with a CLI flag
+## Uncomment to log to a file
+# config :logger, :default_handler,
+#   config: [
+#     file: ~c"logs/system.log",
+#     filesync_repeat_interval: 5000,
+#     file_check: 5000,
+#     max_no_bytes: 10_000_000,
+#     max_no_files: 5,
+#     compress_on_rotate: true
+#   ]
+
 # Configures the phoenix endpoint
 config :lambda_ethereum_consensus, BeaconApi.Endpoint,
   http: [port: 4000],

metrics/docker-compose.yml

@@ -1,19 +1,19 @@
-version: '0.1'
+version: '3'
 name: 'lambda-ethereum-consensus-grafana'
 
 services:
   prometheus:
     image: prom/prometheus
     container_name: prometheus
     hostname: prometheus
-    ports:
-      - "9090:9090"
     volumes:
+      # prometheus configuration
       - ./prometheus:/etc/prometheus
+      # prometheus data
       - prometheus-data:/prometheus
     command: --web.enable-lifecycle  --config.file=/etc/prometheus/prometheus.yml
     networks:
-      open:
+      grafana-prometheus:
         aliases:
           - prometheus
     extra_hosts:
@@ -25,17 +25,79 @@ services:
     ports:
       - "3000:3000"
     volumes:
+      # grafana configuration
       - ./grafana/provisioning:/etc/grafana/provisioning
+      # grafana data
       - grafana-data:/var/lib/grafana
+    environment:
+      # WARNING: use this for same-machine access ONLY
+      GF_AUTH_ANONYMOUS_ENABLED: "true"
+      GF_AUTH_DISABLE_LOGIN_FORM: "true"
+      GF_AUTH_ANONYMOUS_ORG_ROLE: "Admin"
     networks:
-      open:
+      grafana-prometheus:
+        aliases:
+          - grafana
+      grafana-loki:
         aliases:
           - grafana
 
+  # Since the Loki containers are running as user 10001 and the mounted data volume is owned by root,
+  # Loki would not have permissions to create the directories.
+  # Therefore the init container changes permissions of the mounted directory.
+  loki-init:
+    image: &lokiImage grafana/loki:2.9.2
+    user: root
+    entrypoint:
+      - "chown"
+      - "10001:10001"
+      - "/tmp/loki"
+    volumes:
+      - loki-data:/tmp/loki
+
+  loki:
+    image: *lokiImage
+    container_name: loki
+    volumes:
+      # loki configuration
+      - ./loki:/etc/loki
+      # loki data
+      - loki-data:/tmp/loki
+    command: --config.file=/etc/loki/loki.yml
+    networks:
+      grafana-loki:
+        aliases:
+          - loki
+      loki-promtail:
+        aliases:
+          - loki
+
+  promtail:
+    image: grafana/promtail
+    container_name: promtail
+    volumes:
+      # promtail configuration
+      - ./promtail:/etc/promtail
+      # logs to scrape
+      - ../logs:/var/log/consensus
+      # promtail data
+      - promtail-data:/tmp/promtail
+    command: --config.file=/etc/promtail/promtail.yml
+    networks:
+      loki-promtail:
+        aliases:
+          - promtail
+
 networks:
-  open:
+  grafana-prometheus:
+    driver: bridge
+  grafana-loki:
+    driver: bridge
+  loki-promtail:
     driver: bridge
 
 volumes:
   prometheus-data:
   grafana-data:
+  loki-data:
+  promtail-data:

metrics/grafana/provisioning/datasources/loki_ds.yml

@@ -0,0 +1,6 @@
+datasources:
+  - name: Loki
+    access: proxy
+    type: loki
+    url: http://loki:3100
+    isDefault: false

metrics/loki/loki.yml

@@ -0,0 +1,49 @@
+auth_enabled: false
+
+server:
+  http_listen_port: 3100
+  grpc_listen_port: 9096
+
+common:
+  instance_addr: 127.0.0.1
+  path_prefix: /tmp/loki
+  storage:
+    filesystem:
+      chunks_directory: /tmp/loki/chunks
+      rules_directory: /tmp/loki/rules
+  replication_factor: 1
+  ring:
+    kvstore:
+      store: inmemory
+
+query_range:
+  results_cache:
+    cache:
+      embedded_cache:
+        enabled: true
+        max_size_mb: 100
+
+schema_config:
+  configs:
+    - from: 2020-10-24
+      store: boltdb-shipper
+      object_store: filesystem
+      schema: v11
+      index:
+        prefix: index_
+        period: 24h
+
+ruler:
+  alertmanager_url: http://localhost:9093
+# By default, Loki will send anonymous, but uniquely-identifiable usage and configuration
+# analytics to Grafana Labs. These statistics are sent to https://stats.grafana.org/
+#
+# Statistics help us better understand how Loki is used, and they show us performance
+# levels for most users. This helps us prioritize features and documentation.
+# For more information on what's sent, look at
+# https://github.com/grafana/loki/blob/main/pkg/usagestats/stats.go
+# Refer to the buildReport method to see what goes into a report.
+#
+# If you would like to disable reporting, uncomment the following lines:
+#analytics:
+#  reporting_enabled: false

metrics/promtail/promtail.yml

@@ -0,0 +1,18 @@
+server:
+  http_listen_port: 9080
+  grpc_listen_port: 0
+
+positions:
+  filename: /tmp/promtail/positions.yaml
+
+clients:
+  - url: http://loki:3100/loki/api/v1/push
+
+scrape_configs:
+  - job_name: system
+    static_configs:
+      - targets:
+          - localhost
+        labels:
+          job: lambda_ethereum_consensus
+          __path__: /var/log/consensus/*log