Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up opentracing configuration options #5712

Merged
merged 3 commits into from Jul 18, 2019

Conversation

@richvdh
Copy link
Member

commented Jul 18, 2019

Clean up config settings and dead code.

This is mostly about cleaning up the config format, to bring it into line with our conventions. In particular:

  • There should be a blank line after `## Section ##' headings
  • There should be a blank line between each config setting
  • There should be a #-only line between a comment and the setting it describes
  • We don't really do the # # style commenting-out of whole sections if we can help it
  • rename tracer_enabled to enabled

While we're here, do more config parsing upfront, which makes it easier to use
later on.

Also removes redundant code from LogContextScopeManager.

Also changes the changelog fragment to a feature - it's exciting!

@richvdh richvdh requested a review from JorikSchellekens Jul 18, 2019

Clean up opentracing configuration options
Clean up config settings and dead code.

@richvdh richvdh force-pushed the rav/opentracing_cleanup branch from 1ecf54b to 498bec9 Jul 18, 2019

@codecov

This comment has been minimized.

Copy link

commented Jul 18, 2019

Codecov Report

Merging #5712 into develop will increase coverage by 0.01%.
The diff coverage is 50%.

@@             Coverage Diff             @@
##           develop    #5712      +/-   ##
===========================================
+ Coverage    63.42%   63.44%   +0.01%     
===========================================
  Files          331      331              
  Lines        36163    36163              
  Branches      5960     5960              
===========================================
+ Hits         22938    22944       +6     
+ Misses       11597    11591       -6     
  Partials      1628     1628
@JorikSchellekens

This comment has been minimized.

Copy link
Contributor

commented Jul 18, 2019

Looks good. The LogContextScopeManager._homeserver_whitelist was left over from a previous set up. It was rightfully removed.

@JorikSchellekens

This comment has been minimized.

Copy link
Contributor

commented Jul 18, 2019

Looks good. Thanks for the cleanup.

@richvdh richvdh merged commit 82345bc into develop Jul 18, 2019

6 of 17 checks passed

buildkite/synapse Build #2904 started
Details
buildkite/synapse/python-3-dot-5-slash-postgres-9-dot-5 Started...
Details
buildkite/synapse/python-3-dot-5-slash-sqlite Started...
Details
buildkite/synapse/python-3-dot-5-slash-sqlite-slash-old-deps Started...
Details
buildkite/synapse/python-3-dot-6-slash-sqlite Started...
Details
buildkite/synapse/python-3-dot-7-slash-postgres-11 Started...
Details
buildkite/synapse/python-3-dot-7-slash-postgres-9-dot-5 Started...
Details
buildkite/synapse/python-3-dot-7-slash-sqlite Started...
Details
buildkite/synapse/sytest-python-3-dot-5-slash-postgres-9-dot-6-slash-monolith Started...
Details
buildkite/synapse/sytest-python-3-dot-5-slash-postgres-9-dot-6-slash-workers Started...
Details
buildkite/synapse/sytest-python-3-dot-5-slash-sqlite-slash-monolith Started...
Details
buildkite/synapse/check-sample-config Passed (1 minute, 12 seconds)
Details
buildkite/synapse/check-style Passed (1 minute, 13 seconds)
Details
buildkite/synapse/isort Passed (19 seconds)
Details
buildkite/synapse/newspaper-newsfile Passed (18 seconds)
Details
buildkite/synapse/packaging Passed (21 seconds)
Details
buildkite/synapse/pipeline Passed (9 seconds)
Details

@richvdh richvdh deleted the rav/opentracing_cleanup branch Jul 18, 2019

anoadragon453 added a commit that referenced this pull request Jul 22, 2019

Merge tag 'v1.2.0rc1' into develop
v1.2.0rc1

Features
--------

- Add support for opentracing. ([\#5544](#5544), [\#5712](#5712))
- Add ability to pull all locally stored events out of synapse that a particular user can see. ([\#5589](#5589))
- Add a basic admin command app to allow server operators to run Synapse admin commands separately from the main production instance. ([\#5597](#5597))
- Add `sender` and `origin_server_ts` fields to `m.replace`. ([\#5613](#5613))
- Add default push rule to ignore reactions. ([\#5623](#5623))
- Include the original event when asking for its relations. ([\#5626](#5626))
- Implement `session_lifetime` configuration option, after which access tokens will expire. ([\#5660](#5660))
- Return "This account has been deactivated" when a deactivated user tries to login. ([\#5674](#5674))
- Enable aggregations support by default ([\#5714](#5714))

Bugfixes
--------

- Fix 'utime went backwards' errors on daemonization. ([\#5609](#5609))
- Various minor fixes to the federation request rate limiter. ([\#5621](#5621))
- Forbid viewing relations on an event once it has been redacted. ([\#5629](#5629))
- Fix requests to the `/store_invite` endpoint of identity servers being sent in the wrong format. ([\#5638](#5638))
- Fix newly-registered users not being able to lookup their own profile without joining a room. ([\#5644](#5644))
- Fix bug in #5626 that prevented the original_event field from actually having the contents of the original event in a call to `/relations`. ([\#5654](#5654))
- Fix 3PID bind requests being sent to identity servers as `application/x-form-www-urlencoded` data, which is deprecated. ([\#5658](#5658))
- Fix some problems with authenticating redactions in recent room versions. ([\#5699](#5699), [\#5700](#5700), [\#5707](#5707))
- Ignore redactions of m.room.create events. ([\#5701](#5701))

Updates to the Docker image
---------------------------

- Base Docker image on a newer Alpine Linux version (3.8 -> 3.10). ([\#5619](#5619))
- Add missing space in default logging file format generated by the Docker image. ([\#5620](#5620))

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

- Add information about nginx normalisation to reverse_proxy.rst. Contributed by @skalarproduktraum - thanks! ([\#5397](#5397))
- --no-pep517 should be --no-use-pep517 in the documentation to setup the development environment. ([\#5651](#5651))
- Improvements to Postgres setup instructions. Contributed by @Lrizika - thanks! ([\#5661](#5661))
- Minor tweaks to postgres documentation. ([\#5675](#5675))

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

- Remove support for the `invite_3pid_guest` configuration setting. ([\#5625](#5625))

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

- Move logging code out of `synapse.util` and into `synapse.logging`. ([\#5606](#5606), [\#5617](#5617))
- Add a blacklist file to the repo to blacklist certain sytests from failing CI. ([\#5611](#5611))
- Make runtime errors surrounding password reset emails much clearer. ([\#5616](#5616))
- Remove dead code for persiting outgoing federation transactions. ([\#5622](#5622))
- Add `lint.sh` to the scripts-dev folder which will run all linting steps required by CI. ([\#5627](#5627))
- Move RegistrationHandler.get_or_create_user to test code. ([\#5628](#5628))
- Add some more common python virtual-environment paths to the black exclusion list. ([\#5630](#5630))
- Some counter metrics exposed over Prometheus have been renamed, with the old names preserved for backwards compatibility and deprecated. See `docs/metrics-howto.rst` for details. ([\#5636](#5636))
- Unblacklist some user_directory sytests. ([\#5637](#5637))
- Factor out some redundant code in the login implementation. ([\#5639](#5639))
- Update ModuleApi to avoid register(generate_token=True). ([\#5640](#5640))
- Remove access-token support from `RegistrationHandler.register`, and rename it. ([\#5641](#5641))
- Remove access-token support from `RegistrationStore.register`, and rename it. ([\#5642](#5642))
- Improve logging for auto-join when a new user is created. ([\#5643](#5643))
- Remove unused and unnecessary check for FederationDeniedError in _exception_to_failure. ([\#5645](#5645))
- Fix a small typo in a code comment. ([\#5655](#5655))
- Clean up exception handling around client access tokens. ([\#5656](#5656))
- Add a mechanism for per-test homeserver configuration in the unit tests. ([\#5657](#5657))
- Inline issue_access_token. ([\#5659](#5659))
- Update the sytest BuildKite configuration to checkout Synapse in `/src`. ([\#5664](#5664))
- Add a `docker` type to the towncrier configuration. ([\#5673](#5673))
- Convert `synapse.federation.transport.server` to `async`. Might improve some stack traces. ([\#5689](#5689))
- Documentation for opentracing. ([\#5703](#5703))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.