Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

document synctl_cache_factor #6354

Closed
ara4n opened this issue Nov 11, 2019 · 6 comments · Fixed by #11865
Closed

document synctl_cache_factor #6354

ara4n opened this issue Nov 11, 2019 · 6 comments · Fixed by #11865
Labels
good first issue Good for newcomers T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. z-p2 (Deprecated Label)

Comments

@ara4n
Copy link
Member

ara4n commented Nov 11, 2019

we have configs out there using synctl_cache_factor to set SYNAPSE_CACHE_FACTOR but it's not documented anywhere, which makes it look obsolete or abandoned or deprecated. we should doc it so that when people look to see what it does, they can figure it out
@richvdh
Copy link
Member

richvdh commented Nov 11, 2019 •
edited

Imho, the fact that synctl reads a random value in the synapse config file to set an environment variable is confusing at best. It's the synapse config, not the synctl config.

Furthermore, in most situations, synctl is more of a hinderance than a help so encouraging people to try to tune the cache factor by changing the config file rather than setting the env var is going to cause support headaches when it doesn't work because they (rightly) aren't using synctl.

IOW: it's a misfeature which should be deprecated.

@ara4n
Copy link
Member Author

ara4n commented Nov 11, 2019

is there any chance we can make it part of the normal config, rather than as a weird ugly env variable, which is almost as out-of-place and jarring as the even weirder read-by-synctl config? (and then we could keep compat for those using it)

@richvdh
Copy link
Member

richvdh commented Nov 12, 2019

that would be the ideal. but is surprisingly hard. The problem is that the caches are created before the config is read.

I mean, it's obviously possible, but given the effort/reward balance, it's not something I'd prioritise.

@richvdh
Copy link
Member

richvdh commented Nov 12, 2019

I think the actionable point here on this issue is "emit a warning when people set synctl_cache_factor to say that it is deprecated and that they should set the env var instead"?

@neilisfragile neilisfragile added enhancement z-p2 (Deprecated Label) labels Nov 14, 2019
@aaronraimist
Copy link
Contributor

is there any chance we can make it part of the normal config, rather than as a weird ugly env variable, which is almost as out-of-place and jarring as the even weirder read-by-synctl config? (and then we could keep compat for those using it)

Seems like #6391 does this

neilisfragile added a commit that referenced this issue Dec 9, 2019
@neilisfragile
Merge tag 'v1.7.0rc1' into develop
0f3614f 
Synapse 1.7.0rc1 (2019-12-09)
=============================

Features
--------

- Implement per-room message retention policies. ([\#5815](#5815), [\#6436](#6436))
- Add etag and count fields to key backup endpoints to help clients guess if there are new keys. ([\#5858](#5858))
- Add `/admin/v2/users` endpoint with pagination. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#5925](#5925))
- Require User-Interactive Authentication for `/account/3pid/add`, meaning the user's password will be required to add a third-party ID to their account. ([\#6119](#6119))
- Implement the `/_matrix/federation/unstable/net.atleastfornow/state/<context>` API as drafted in MSC2314. ([\#6176](#6176))
- Configure privacy-preserving settings by default for the room directory. ([\#6354](#6354))
- Add ephemeral messages support by partially implementing [MSC2228](matrix-org/matrix-spec-proposals#2228). ([\#6409](#6409))
- Add support for [MSC 2367](matrix-org/matrix-spec-proposals#2367), which allows specifying a reason on all membership events. ([\#6434](#6434))

Bugfixes
--------

- Transfer non-standard power levels on room upgrade. ([\#6237](#6237))
- Fix error from the Pillow library when uploading RGBA images. ([\#6241](#6241))
- Correctly apply the event filter to the `state`, `events_before` and `events_after` fields in the response to `/context` requests. ([\#6329](#6329))
- Fix caching devices for remote users when using workers, so that we don't attempt to refetch (and potentially fail) each time a user requests devices. ([\#6332](#6332))
- Prevent account data syncs getting lost across TCP replication. ([\#6333](#6333))
- Fix bug: TypeError in `register_user()` while using LDAP auth module. ([\#6406](#6406))
- Fix an intermittent exception when handling read-receipts. ([\#6408](#6408))
- Fix broken guest registration when there are existing blocks of numeric user IDs. ([\#6420](#6420))
- Fix startup error when http proxy is defined. ([\#6421](#6421))
- Fix error when using synapse_port_db on a vanilla synapse db. ([\#6449](#6449))
- Fix uploading multiple cross signing signatures for the same user. ([\#6451](#6451))
- Fix bug which lead to exceptions being thrown in a loop when a cross-signed device is deleted. ([\#6462](#6462))
- Fix `synapse_port_db` not exiting with a 0 code if something went wrong during the port process. ([\#6470](#6470))
- Improve sanity-checking when receiving events over federation. ([\#6472](#6472))
- Fix inaccurate per-block Prometheus metrics. ([\#6491](#6491))
- Fix small performance regression for sending invites. ([\#6493](#6493))
- Back out cross-signing code added in Synapse 1.5.0, which caused a performance regression. ([\#6494](#6494))

Improved Documentation
----------------------

- Update documentation and variables in user contributed systemd reference file. ([\#6369](#6369), [\#6490](#6490))
- Fix link in the user directory documentation. ([\#6388](#6388))
- Add build instructions to the docker readme. ([\#6390](#6390))
- Switch Ubuntu package install recommendation to use python3 packages in INSTALL.md. ([\#6443](#6443))
- Write some docs for the quarantine_media api. ([\#6458](#6458))
- Convert CONTRIBUTING.rst to markdown (among other small fixes). ([\#6461](#6461))

Deprecations and Removals
-------------------------

- Remove admin/v1/users_paginate endpoint. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#5925](#5925))
- Remove fallback for federation with old servers which lack the /federation/v1/state_ids API. ([\#6488](#6488))

Internal Changes
----------------

- Add benchmarks for structured logging and improve output performance. ([\#6266](#6266))
- Improve the performance of outputting structured logging. ([\#6322](#6322))
- Refactor some code in the event authentication path for clarity. ([\#6343](#6343), [\#6468](#6468), [\#6480](#6480))
- Clean up some unnecessary quotation marks around the codebase. ([\#6362](#6362))
- Complain on startup instead of 500'ing during runtime when `public_baseurl` isn't set when necessary. ([\#6379](#6379))
- Add a test scenario to make sure room history purges don't break `/messages` in the future. ([\#6392](#6392))
- Clarifications for the email configuration settings. ([\#6423](#6423))
- Add more tests to the blacklist when running in worker mode. ([\#6429](#6429))
- Refactor data store layer to support multiple databases in the future. ([\#6454](#6454), [\#6464](#6464), [\#6469](#6469), [\#6487](#6487))
- Port synapse.rest.client.v1 to async/await. ([\#6482](#6482))
- Port synapse.rest.client.v2_alpha to async/await. ([\#6483](#6483))
- Port SyncHandler to async/await. ([\#6484](#6484))
@richvdh richvdh added the good first issue Good for newcomers label Apr 6, 2021
@erikjohnston erikjohnston added T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. and removed z-enhancement labels Jul 26, 2021
@lukasdenk
Copy link
Contributor

lukasdenk commented Jan 31, 2022 •
edited

I think the actionable point here on this issue is "emit a warning when people set synctl_cache_factor to say that it is deprecated and that they should set the env var instead"?

@richvdh I'll work on it

@lukasdenk lukasdenk mentioned this issue Jan 31, 2022
Merged
4 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
good first issue Good for newcomers T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. z-p2 (Deprecated Label)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Print warning if synctl_cache_factor is set in config
6 participants
@neilisfragile @ara4n @richvdh @aaronraimist @erikjohnston @lukasdenk