Skip to content

Commit d662c70

Browse files
authored
Merge pull request #78 from opensensor/setup/sentry-opensensor
Add OpenSensor API Sentry monitoring
2 parents 2200a12 + bad70b1 commit d662c70

6 files changed

Lines changed: 75 additions & 1 deletion

File tree

‎.github/workflows/build_api/action.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ runs:
4848
shell: bash
4949
run: >
5050
docker build ${{ inputs.docker_build_context }}
51+
--build-arg SENTRY_RELEASE="opensensor-api@${GITHUB_SHA}"
5152
-f ${{ inputs.dockerfile }}
5253
-t ${{ steps.image_tags.outputs.sha }}
5354
-t ${{ steps.image_tags.outputs.latest }}

‎Dockerfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,10 @@ USER opensensor-api
3939
ENV TZ=UTC
4040

4141
# Start opensensor API
42+
# Public Sentry ingestion key; upload credentials are never part of the image.
43+
ARG SENTRY_RELEASE
44+
ENV SENTRY_DSN=https://f342f997ac7c582759f18b6d46a71956@o4512337837686784.ingest.us.sentry.io/4512337894637568 \
45+
SENTRY_ENVIRONMENT=production \
46+
SENTRY_RELEASE=${SENTRY_RELEASE}
47+
4248
CMD ["/usr/src/.venv/bin/uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8010", "--timeout-keep-alive", "30", "--log-level", "info"]

‎Pipfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ verify_ssl = true
44
name = "pypi"
55

66
[packages]
7+
sentry-sdk = "==2.73.0"
78
fastapi = "*"
89
uvicorn = "*"
910
pydantic = "*"

‎Pipfile.lock‎

Lines changed: 18 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎main.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
from opensensor.app import app
44
from opensensor.collection_apis import router as collection_apis_router
55
from opensensor.devices import router as device_apis_router
6+
from opensensor.observability import init_sentry
7+
8+
init_sentry()
69

710

811
@app.get("/")

‎opensensor/observability.py‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
"""Opt-in Sentry error and trace capture; no request payloads or local variables."""
2+
3+
import os
4+
from urllib.parse import urlsplit, urlunsplit
5+
6+
import sentry_sdk
7+
8+
9+
def scrub_event(event, hint):
10+
request = event.get("request")
11+
if request:
12+
for key in ("data", "cookies", "headers", "query_string"):
13+
request.pop(key, None)
14+
if request.get("url"):
15+
parts = urlsplit(request["url"])
16+
request["url"] = urlunsplit((parts.scheme, parts.netloc, parts.path, "", ""))
17+
event.pop("user", None)
18+
event.pop("extra", None)
19+
event["breadcrumbs"] = {"values": []}
20+
return event
21+
22+
23+
def init_sentry() -> None:
24+
dsn = os.environ.get("SENTRY_DSN")
25+
if not dsn or os.environ.get("SENTRY_ENABLED", "true").lower() == "false":
26+
return
27+
sentry_sdk.init(
28+
dsn=dsn,
29+
environment=os.environ.get("SENTRY_ENVIRONMENT", "production"),
30+
release=os.environ.get("SENTRY_RELEASE") or None,
31+
traces_sample_rate=0.1,
32+
data_collection={
33+
"user_info": False,
34+
"cookies": {"mode": "off"},
35+
"http_headers": {"request": {"mode": "off"}},
36+
"http_bodies": [],
37+
"url_query_params": {"mode": "off"},
38+
"database_query_data": False,
39+
"queues": False,
40+
"stack_frame_variables": False,
41+
"gen_ai": {"inputs": False, "outputs": False},
42+
"graphql": {"document": False, "variables": False},
43+
},
44+
before_send=scrub_event,
45+
before_send_transaction=scrub_event,
46+
)

0 commit comments

Comments
 (0)