Neilj/mau tracking config explainer #5284

neilisfragile · 2019-05-29T08:29:12Z

No description provided.

babolivier

lgtm once CI passes

richvdh

you'll need to run the script to update the sample config.

Any chance of documenting the other two options while you're there?

synapse/config/server.py

richvdh · 2019-05-29T10:25:18Z

synapse/config/server.py

@@ -584,6 +584,13 @@ def default_config(self, server_name, data_dir_path, **kwargs):
        #hs_disabled_limit_type: 'error code(str), to help clients decode reason'

        # Monthly Active User Blocking
+        # Used in cases where the admin or server owner wants to limit to the
+        # number of monthly active users.


Could you document what happens when the limit is hit?

Co-Authored-By: Richard van der Hoff <[email protected]>

codecov · 2019-05-29T10:39:50Z

Codecov Report

Merging #5284 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #5284   +/-   ##
========================================
  Coverage    62.82%   62.82%           
========================================
  Files          341      341           
  Lines        35458    35458           
  Branches      5799     5799           
========================================
  Hits         22278    22278           
  Misses       11612    11612           
  Partials      1568     1568

Co-Authored-By: Richard van der Hoff <[email protected]>

anoadragon453

LGTM otherwise

docs/sample_config.yaml

anoadragon453 · 2019-06-05T11:13:57Z

synapse/config/server.py

+        # number of monthly active users.
+        #
+        # 'limit_usage_by_mau' disables/enables monthly active user blocking. When
+        # anabled and a limit is reached the server returns a 'ResourceLimitError'


anoadragon453 · 2019-06-05T11:14:14Z

synapse/config/server.py

@@ -585,10 +585,26 @@ def default_config(self, server_name, data_dir_path, **kwargs):

        # Monthly Active User Blocking
        #
+        # Used in cases where the admin or server owner wants to limit to the


anoadragon453 · 2019-06-05T11:14:25Z

synapse/config/server.py

+        #
+        # 'limit_usage_by_mau' disables/enables monthly active user blocking. When
+        # anabled and a limit is reached the server returns a 'ResourceLimitError'
+        # with error type Codes.RESOURCE_LIMIT_EXCEEDED


anoadragon453 · 2019-06-05T11:14:30Z

synapse/config/server.py

+        # 'max_mau_value' is the hard limit of monthly active users above which
+        # the server will start blocking user actions.
+        #
+        # 'mau_trial_days' is a means to add a grace period for active users. It


anoadragon453 · 2019-06-05T11:14:46Z

synapse/config/server.py

        #limit_usage_by_mau: False
        #max_mau_value: 50
        #mau_trial_days: 2
-
+        #


Remove this

Co-Authored-By: Andrew Morgan <[email protected]>

all comments addressed

@dnaf

Synapse 1.0.0rc1 (2019-06-07) ============================= Features -------- - Synapse now more efficiently collates room statistics. ([\#4338](#4338), [\#5260](#5260), [\#5324](#5324)) - Add experimental support for relations (aka reactions and edits). ([\#5220](#5220)) - Ability to configure default room version. ([\#5223](#5223), [\#5249](#5249)) - Allow configuring a range for the account validity startup job. ([\#5276](#5276)) - CAS login will now hit the r0 API, not the deprecated v1 one. ([\#5286](#5286)) - Validate federation server TLS certificates by default (implements [MSC1711](https://github.com/matrix-org/matrix-doc/blob/master/proposals/1711-x509-for-federation.md)). ([\#5359](#5359)) - Update /_matrix/client/versions to reference support for r0.5.0. ([\#5360](#5360)) - Add a script to generate new signing-key files. ([\#5361](#5361)) - Update upgrade and installation guides ahead of 1.0. ([\#5371](#5371)) - Replace the `perspectives` configuration section with `trusted_key_servers`, and make validating the signatures on responses optional (since TLS will do this job for us). ([\#5374](#5374)) - Add ability to perform password reset via email without trusting the identity server. ([\#5377](#5377)) - Set default room version to v4. ([\#5379](#5379)) Bugfixes -------- - Fixes client-server API not sending "m.heroes" to lazy-load /sync requests when a rooms name or its canonical alias are empty. Thanks to @dnaf for this work! ([\#5089](#5089)) - Prevent federation device list updates breaking when processing multiple updates at once. ([\#5156](#5156)) - Fix worker registration bug caused by ClientReaderSlavedStore being unable to see get_profileinfo. ([\#5200](#5200)) - Fix race when backfilling in rooms with worker mode. ([\#5221](#5221)) - Fix appservice timestamp massaging. ([\#5233](#5233)) - Ensure that server_keys fetched via a notary server are correctly signed. ([\#5251](#5251)) - Show the correct error when logging out and access token is missing. ([\#5256](#5256)) - Fix error code when there is an invalid parameter on /_matrix/client/r0/publicRooms ([\#5257](#5257)) - Fix error when downloading thumbnail with missing width/height parameter. ([\#5258](#5258)) - Fix schema update for account validity. ([\#5268](#5268)) - Fix bug where we leaked extremities when we soft failed events, leading to performance degradation. ([\#5274](#5274), [\#5278](#5278), [\#5291](#5291)) - Fix "db txn 'update_presence' from sentinel context" log messages. ([\#5275](#5275)) - Fix dropped logcontexts during high outbound traffic. ([\#5277](#5277)) - Fix a bug where it is not possible to get events in the federation format with the request `GET /_matrix/client/r0/rooms/{roomId}/messages`. ([\#5293](#5293)) - Fix performance problems with the rooms stats background update. ([\#5294](#5294)) - Fix noisy 'no key for server' logs. ([\#5300](#5300)) - Fix bug where a notary server would sometimes forget old keys. ([\#5307](#5307)) - Prevent users from setting huge displaynames and avatar URLs. ([\#5309](#5309)) - Fix handling of failures when processing incoming events where calling `/event_auth` on remote server fails. ([\#5317](#5317)) - Ensure that we have an up-to-date copy of the signing key when validating incoming federation requests. ([\#5321](#5321)) - Fix various problems which made the signing-key notary server time out for some requests. ([\#5333](#5333)) - Fix bug which would make certain operations (such as room joins) block for 20 minutes while attemoting to fetch verification keys. ([\#5334](#5334)) - Fix a bug where we could rapidly mark a server as unreachable even though it was only down for a few minutes. ([\#5335](#5335), [\#5340](#5340)) - Fix a bug where account validity renewal emails could only be sent when email notifs were enabled. ([\#5341](#5341)) - Fix failure when fetching batches of events during backfill, etc. ([\#5342](#5342)) - Add a new room version where the timestamps on events are checked against the validity periods on signing keys. ([\#5348](#5348), [\#5354](#5354)) - Fix room stats and presence background updates to correctly handle missing events. ([\#5352](#5352)) - Include left members in room summaries' heroes. ([\#5355](#5355)) - Fix `federation_custom_ca_list` configuration option. ([\#5362](#5362)) - Fix missing logcontext warnings on shutdown. ([\#5369](#5369)) Improved Documentation ---------------------- - Fix docs on resetting the user directory. ([\#5282](#5282)) - Fix notes about ACME in the MSC1711 faq. ([\#5357](#5357)) Internal Changes ---------------- - Synapse will now serve the experimental "room complexity" API endpoint. ([\#5216](#5216)) - The base classes for the v1 and v2_alpha REST APIs have been unified. ([\#5226](#5226), [\#5328](#5328)) - Simplifications and comments in do_auth. ([\#5227](#5227)) - Remove urllib3 pin as requests 2.22.0 has been released supporting urllib3 1.25.2. ([\#5230](#5230)) - Preparatory work for key-validity features. ([\#5232](#5232), [\#5234](#5234), [\#5235](#5235), [\#5236](#5236), [\#5237](#5237), [\#5244](#5244), [\#5250](#5250), [\#5296](#5296), [\#5299](#5299), [\#5343](#5343), [\#5347](#5347), [\#5356](#5356)) - Specify the type of reCAPTCHA key to use. ([\#5283](#5283)) - Improve sample config for monthly active user blocking. ([\#5284](#5284)) - Remove spurious debug from MatrixFederationHttpClient.get_json. ([\#5287](#5287)) - Improve logging for logcontext leaks. ([\#5288](#5288)) - Clarify that the admin change password API logs the user out. ([\#5303](#5303)) - New installs will now use the v54 full schema, rather than the full schema v14 and applying incremental updates to v54. ([\#5320](#5320)) - Improve docstrings on MatrixFederationClient. ([\#5332](#5332)) - Clean up FederationClient.get_events for clarity. ([\#5344](#5344)) - Various improvements to debug logging. ([\#5353](#5353)) - Don't run CI build checks until sample config check has passed. ([\#5370](#5370)) - Automatically retry buildkite builds (max twice) when an agent is lost. ([\#5380](#5380))

neilisfragile added 2 commits May 29, 2019 09:26

explain Monthly Active User Blocking and mau_trial_days

848c68c

towncrier

ff5b05f

neilisfragile requested a review from a team May 29, 2019 08:29

babolivier approved these changes May 29, 2019

View reviewed changes

richvdh previously requested changes May 29, 2019

View reviewed changes

Update synapse/config/server.py

49a379c

Co-Authored-By: Richard van der Hoff <[email protected]>

neilisfragile and others added 5 commits May 29, 2019 11:39

Update synapse/config/server.py

5b59796

Co-Authored-By: Richard van der Hoff <[email protected]>

update sample config

7f29b15

doc the remaining mau blocking config options

00fb947

typo tweaks

f207084

update sample to include recent typo fixes

12b9035

neilisfragile requested a review from a team June 5, 2019 11:09

anoadragon453 approved these changes Jun 5, 2019

View reviewed changes

neilisfragile and others added 5 commits June 5, 2019 12:35

Update docs/sample_config.yaml

aee9269

Co-Authored-By: Andrew Morgan <[email protected]>

Update docs/sample_config.yaml

488a793

Co-Authored-By: Andrew Morgan <[email protected]>

Update docs/sample_config.yaml

0aac83b

Co-Authored-By: Andrew Morgan <[email protected]>

Update docs/sample_config.yaml

15f6b5b

Co-Authored-By: Andrew Morgan <[email protected]>

typo and update sample_config

e36e103

neilisfragile merged commit 2671351 into develop Jun 5, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Neilj/mau tracking config explainer #5284

Neilj/mau tracking config explainer #5284

neilisfragile commented May 29, 2019 •

edited

Loading

babolivier left a comment

richvdh left a comment

richvdh May 29, 2019

codecov bot commented May 29, 2019 •

edited

Loading

anoadragon453 left a comment

anoadragon453 Jun 5, 2019

anoadragon453 Jun 5, 2019

anoadragon453 Jun 5, 2019

anoadragon453 Jun 5, 2019

anoadragon453 Jun 5, 2019

Neilj/mau tracking config explainer #5284

Neilj/mau tracking config explainer #5284

Conversation

neilisfragile commented May 29, 2019 • edited Loading

babolivier left a comment

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

richvdh May 29, 2019

Choose a reason for hiding this comment

codecov bot commented May 29, 2019 • edited Loading

Codecov Report

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 Jun 5, 2019

Choose a reason for hiding this comment

anoadragon453 Jun 5, 2019

Choose a reason for hiding this comment

anoadragon453 Jun 5, 2019

Choose a reason for hiding this comment

anoadragon453 Jun 5, 2019

Choose a reason for hiding this comment

anoadragon453 Jun 5, 2019

Choose a reason for hiding this comment

neilisfragile commented May 29, 2019 •

edited

Loading

codecov bot commented May 29, 2019 •

edited

Loading