- Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmain.py
More file actions
Latest commit
211 lines (168 loc) · 6.58 KB
/
Copy pathmain.py
File metadata and controls
211 lines (168 loc) · 6.58 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
importdatetime
importuuid
fromtypingimportAnnotated, Any, Dict, Optional
fromfastapiimportDepends
fromfastapi.responsesimportJSONResponse
fromloguruimportlogger
frompydanticimportBaseModel, Field
fromconfigimportSettings, get_settings
# don't change ordering here, settings must be called prior to initialization of app.core.factory
_settings=get_settings()
fromapp.core.factoryimportcreate_app# noqa: E402
# https://brandur.org/logfmt
# https://github.com/Delgan/loguru
# https://betterstack.com/community/guides/logging/loguru/
defisRunning(settings: Settings) ->bool:
# logger.info(f"App state: {dict(app.state.__dict__)}")
running=getattr(app.state, "running", False)
logger.info(f"Running state: {running}")
logger.info(f"Environment: {settings.current_env}")
returnrunning
defis_configured(settings: Settings) ->bool:
returnbool(settings.project_name)
""" {
"status": "pass|fail|warn", // Required
"version": "1.0", // Optional
"description": "...", // Optional
"checks": { // Optional, for detailed component status
"database": {
"status": "up",
"responseTime": "23ms"
},
"cache": {
"status": "up",
"responseTime": "5ms"
}
}
} """
classHealthCheck(BaseModel):
"""RFC Health Check response format."""
status: str=Field(
..., description="Required. Status of the service: pass, fail, or warn"
)
version: Optional[str] =Field(None, description="Version of the service")
env: Optional[str] =Field(None, description="Environment of the service")
description: Optional[str] =Field(
None, description="Human-friendly description of the service"
)
checks: Optional[Dict[str, Dict[str, Any]]] =Field(
None, description="Additional checks"
)
defcreate_health_response(is_healthy: bool, check_name: str) ->JSONResponse:
"""Create a standardized health check response."""
status="pass"ifis_healthyelse"fail"
response=HealthCheck(
status=status,
version=get_settings().project_name,
env=get_settings().current_env,
description=f"Service {status}",
checks={
check_name: {
"status": status,
"time": datetime.datetime.now().isoformat(),
}
},
)
returnJSONResponse(
status_code=200ifis_healthyelse503,
content=response.model_dump(),
media_type="application/health+json",
)
app=create_app(_settings)
# middleware options
# https://levelup.gitconnected.com/17-useful-middlewares-for-fastapi-that-you-should-know-about-951c2b0869c7
# https://fastapi.tiangolo.com/tutorial/middleware/
# https://http.dev/headers
# CORS
# Authorization and Authentication
# Localization
# Caching
# Rate Limiting
# Tracing
# Dependency Injection
# A/B testing
# Metrics
# Route security, ip address and user agent - TrustedHostMiddleware
# gzip compression - GZipMiddleware
# ssl enforcement - HTTPSRedirectMiddleware
# request state
# request IDs
@app.middleware("http")
asyncdefadd_request_id(request, call_next):
request_id=str(uuid.uuid4())
request.state.request_id=request_id
response=awaitcall_next(request)
response.headers["X-Request-ID"] =request_id
logger.info(f"Request {request_id} to {request.url.path}")
returnresponse
@app.middleware("http")
asyncdefadd_process_time_header(request, call_next):
importtime
start_time=time.perf_counter()
response=awaitcall_next(request)
process_time=time.perf_counter() -start_time
response.headers["X-Process-Time"] =str(process_time)
logger.info(f"Request to {request.url.path} took {process_time:.4f} seconds")
returnresponse
@app.get("/")
asyncdefroot(settings: Annotated[Settings, Depends(get_settings)]) ->Dict[str, Any]:
return {
"app_name": settings.project_name,
"system_time": datetime.datetime.now(),
}
@app.get("/info")
asyncdefinfo(settings: Annotated[Settings, Depends(get_settings)]) ->Dict[str, Any]:
return {
"app_name": settings.project_name,
"system_time": datetime.datetime.now(),
"database_type": settings.database_type,
"env": settings.current_env,
"settings": settings.model_dump(),
}
# Health check endpoints
# Startup: Signals if the application has completed its initial startup
# Smoke: Verifies basic configuration and dependencies
# Readiness: Shows if the application is ready to handle requests
# Liveness: Indicates if the application is running and alive
# https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check
# https://inadarei.github.io/rfc-healthcheck/
# https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
# https://docs.digitalocean.com/products/paperspace/deployments/reference/health-checks/
@app.get("/health", response_class=JSONResponse)
asyncdefhealth_check(
settings: Annotated[Settings, Depends(get_settings)],
) ->JSONResponse:
"""Overall service health check."""
returncreate_health_response(isRunning(settings), "service")
@app.get("/liveness", response_class=JSONResponse)
asyncdefliveness_check(
settings: Annotated[Settings, Depends(get_settings)],
) ->JSONResponse:
"""Service liveness check."""
returncreate_health_response(isRunning(settings), "liveness")
@app.get("/startup", response_class=JSONResponse)
asyncdefstartup_check(
settings: Annotated[Settings, Depends(get_settings)],
) ->JSONResponse:
"""Startup health check."""
returncreate_health_response(isRunning(settings), "startup")
@app.get("/readiness", response_class=JSONResponse)
asyncdefreadiness_check(
settings: Annotated[Settings, Depends(get_settings)],
) ->JSONResponse:
"""Service readiness check."""
returncreate_health_response(isRunning(settings), "readiness")
@app.get("/smoke", response_class=JSONResponse)
asyncdefsmoke_check(
settings: Annotated[Settings, Depends(get_settings)],
) ->JSONResponse:
"""Configuration smoke test."""
returncreate_health_response(is_configured(settings), "configuration")
# if unit test for health check is desired
# https://fastapi.tiangolo.com/advanced/testing-events/
# https://github.com/Kludex/fastapi-health/blob/main/tests/test_endpoint.py
# if metadata output is desired on health check
# https://fastapi.tiangolo.com/tutorial/metadata/
# reverse proxy and system serice manager
# https://medium.com/@kevinzeladacl/deploy-a-fastapi-app-with-nginx-and-gunicorn-b66ac14cdf5a
# https://fastapi.tiangolo.com/advanced/behind-a-proxy/