Pusher + Metrics

files/log/pusher.yaml

@@ -0,0 +1,84 @@
+# Log configuration for Synapse.
+#
+# This is a YAML file containing a standard Python logging configuration
+# dictionary. See [1] for details on the valid settings.
+#
+# Synapse also supports structured logging for machine readable logs which can
+# be ingested by ELK stacks. See [2] for details.
+#
+# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema
+# [2]: https://matrix-org.github.io/synapse/latest/structured_logging.html
+
+version: 1
+
+formatters:
+    precise:
+        format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+
+handlers:
+    file:
+        class: logging.handlers.TimedRotatingFileHandler
+        formatter: INFO
+        filename: /data/workers/pusher.log
+        when: midnight
+        backupCount: 2  # Does not include the current log file.
+        encoding: utf8
+
+    # Default to buffering writes to log file for efficiency.
+    # WARNING/ERROR logs will still be flushed immediately, but there will be a
+    # delay (of up to `period` seconds, or until the buffer is full with
+    # `capacity` messages) before INFO/DEBUG logs get written.
+    buffer:
+        class: synapse.logging.handlers.PeriodicallyFlushingMemoryHandler
+        target: file
+
+        # The capacity is the maximum number of log lines that are buffered
+        # before being written to disk. Increasing this will lead to better
+        # performance, at the expensive of it taking longer for log lines to
+        # be written to disk.
+        # This parameter is required.
+        capacity: 10
+
+        # Logs with a level at or above the flush level will cause the buffer to
+        # be flushed immediately.
+        # Default value: 40 (ERROR)
+        # Other values: 50 (CRITICAL), 30 (WARNING), 20 (INFO), 10 (DEBUG)
+        flushLevel: 20  # Flush immediately for WARNING logs and higher
+
+        # The period of time, in seconds, between forced flushes.
+        # Messages will not be delayed for longer than this time.
+        # Default value: 5 seconds
+        period: 5
+
+    # A handler that writes logs to stderr. Unused by default, but can be used
+    # instead of "buffer" and "file" in the logger handlers.
+    console:
+        class: logging.StreamHandler
+        formatter: precise
+
+loggers:
+    synapse.storage.SQL:
+        # beware: increasing this to DEBUG will make synapse log sensitive
+        # information such as access tokens.
+        level: WARN
+
+    twisted:
+        # We send the twisted logging directly to the file handler,
+        # to work around https://github.com/matrix-org/synapse/issues/3471
+        # when using "buffer" logger. Use "console" to log to stderr instead.
+        handlers: [file]
+        propagate: false
+
+root:
+    level: INFO
+
+    # Write logs to the `buffer` handler, which will buffer them together in memory,
+    # then write them to a file.
+    #
+    # Replace "buffer" with "console" to log to stderr instead. (Note that you'll
+    # also need to update the configuration for the `twisted` logger above, in
+    # this case.)
+    #
+    handlers: [buffer]
+
+disable_existing_loggers: false

files/workers/federation1.yaml

@@ -3,5 +3,8 @@ worker_name: federation1
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_replication_http_tls: false
 worker_log_config: /data/log/federation1.yaml
+
+worker_listeners:
+  - type: metrics
+    port: 9092

files/workers/federation2.yaml

@@ -3,5 +3,8 @@ worker_name: federation2
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_replication_http_tls: false
 worker_log_config: /data/log/federation2.yaml
+
+worker_listeners:
+  - type: metrics
+    port: 9092

files/workers/federation3.yaml

@@ -3,5 +3,8 @@ worker_name: federation3
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_replication_http_tls: false
 worker_log_config: /data/log/federation3.yaml
+
+worker_listeners:
+  - type: metrics
+    port: 9092

files/workers/pusher.yaml

@@ -0,0 +1,10 @@
+worker_app: synapse.app.generic_worker
+worker_name: pusher
+
+worker_replication_host: synapse
+worker_replication_http_port: 9093
+worker_log_config: /data/log/pusher.yaml
+
+worker_listeners:
+  - type: metrics
+    port: 9092

files/workers/sync1.yaml

@@ -3,14 +3,19 @@ worker_name: sync1
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/sync1.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
       - names: [client, federation]
-        compress: false
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    port: 9092

files/workers/sync2.yaml

@@ -3,13 +3,20 @@ worker_name: sync2
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/sync2.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/sync3.yaml

@@ -3,13 +3,20 @@ worker_name: sync3
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/sync3.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/sync4.yaml

@@ -3,14 +3,20 @@ worker_name: sync4
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_replication_http_tls: false
-worker_main_http_uri: http://synapse:8008/
-
 worker_log_config: /data/log/sync4.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/sync5.yaml

@@ -3,13 +3,20 @@ worker_name: sync5
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/sync5.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/worker1.yaml

@@ -3,13 +3,20 @@ worker_name: worker1
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_replication_http_tls: false
-worker_main_http_uri: http://synapse:8008/
 worker_log_config: /data/log/worker1.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/worker2.yaml

@@ -3,13 +3,20 @@ worker_name: worker2
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/worker2.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/worker3.yaml

@@ -3,13 +3,20 @@ worker_name: worker3
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/worker3.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092

files/workers/worker4.yaml

@@ -3,13 +3,20 @@ worker_name: worker4
 
 worker_replication_host: synapse
 worker_replication_http_port: 9093
-worker_main_http_uri: http://synapse:8008/
-worker_replication_http_tls: false
 worker_log_config: /data/log/worker4.yaml
 
 worker_listeners:
   - type: http
     port: 8081
     x_forwarded: true
+    tls: false
     resources:
-      - names: [client, federation]
+      - names: [client, federation]
+        compress: false
+  - type: http
+    port: 9091
+    resources:
+      - names: [replication]
+  - type: metrics
+    bind_addresses: ['0.0.0.0']
+    port: 9092