1# Copyright 2020 The Matrix.org Foundation C.I.C. 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14 15from twisted.web.resource import Resource 16from twisted.web.server import Request 17 18 19class HealthResource(Resource): 20 """A resource that does nothing except return a 200 with a body of `OK`, 21 which can be used as a health check. 22 23 Note: `SynapseRequest._should_log_request` ensures that requests to 24 `/health` do not get logged at INFO. 25 """ 26 27 isLeaf = 1 28 29 def render_GET(self, request: Request) -> bytes: 30 request.setHeader(b"Content-Type", b"text/plain") 31 return b"OK" 32