Skip to content

Commit 474e97c

Browse files
authored
docs: added sentry guide (medusajs#12744)
* docs: added sentry guide * added error capturing * generate
1 parent 85bc396 commit 474e97c

File tree

13 files changed

+916
-17
lines changed

13 files changed

+916
-17
lines changed

www/apps/book/app/learn/debugging-and-testing/instrumentation/page.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,15 @@ export const metadata = {
88

99
In this chapter, you'll learn about observability in Medusa and how to configure instrumentation with OpenTelemetry.
1010

11-
## Observability with OpenTelemtry
11+
## What is Instrumentation?
12+
13+
Instrumentation is the collection of data about your application's performance and errors. It helps you debug issues, monitor performance, and gain insights into how your application behaves in production.
14+
15+
Instrumentation and observability are crucial as you build customizations in your application. They allow you to optimize performance, identify bottlenecks, and ensure your application runs smoothly.
16+
17+
---
18+
19+
## Instrumentation and Observability with OpenTelemetry
1220

1321
Medusa uses [OpenTelemetry](https://opentelemetry.io/) for instrumentation and reporting. When configured, it reports traces for:
1422

@@ -158,3 +166,9 @@ Trace span names start with the following keywords based on what it's reporting:
158166
- `step:` when reporting a step in a workflow execution.
159167
- `query.graph:` when reporting Query usages.
160168
- `pg.query:` when reporting database queries and operations.
169+
170+
---
171+
172+
## Useful Links
173+
174+
- [Integrate Sentry with Medusa](!resources!/integrations/guides/sentry)

www/apps/book/generated/edit-dates.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export const generatedEditDates = {
7070
"app/learn/fundamentals/modules/db-operations/page.mdx": "2025-04-25T14:26:25.000Z",
7171
"app/learn/fundamentals/modules/multiple-services/page.mdx": "2025-03-18T15:11:44.632Z",
7272
"app/learn/fundamentals/modules/page.mdx": "2025-03-18T07:51:09.049Z",
73-
"app/learn/debugging-and-testing/instrumentation/page.mdx": "2025-02-24T08:12:53.132Z",
73+
"app/learn/debugging-and-testing/instrumentation/page.mdx": "2025-06-16T10:40:52.922Z",
7474
"app/learn/fundamentals/api-routes/additional-data/page.mdx": "2025-04-17T08:50:17.036Z",
7575
"app/learn/fundamentals/workflows/variable-manipulation/page.mdx": "2025-04-24T13:14:43.967Z",
7676
"app/learn/customization/custom-features/api-route/page.mdx": "2024-12-09T10:39:30.046Z",

www/apps/book/generated/sidebar.mjs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1128,7 +1128,18 @@ export const generatedSidebars = [
11281128
"type": "link",
11291129
"path": "/learn/debugging-and-testing/instrumentation",
11301130
"title": "Instrumentation",
1131-
"children": [],
1131+
"children": [
1132+
{
1133+
"loaded": true,
1134+
"isPathHref": true,
1135+
"type": "ref",
1136+
"path": "/resources/integrations/guides/sentry",
1137+
"title": "Guide: Sentry",
1138+
"children": [],
1139+
"chapterTitle": "7.4.1. Guide: Sentry",
1140+
"number": "7.4.1."
1141+
}
1142+
],
11321143
"chapterTitle": "7.4. Instrumentation",
11331144
"number": "7.4."
11341145
},

www/apps/book/public/llms-full.txt

Lines changed: 390 additions & 2 deletions
Large diffs are not rendered by default.

www/apps/book/sidebar.mjs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -593,6 +593,13 @@ export const sidebars = [
593593
type: "link",
594594
path: "/learn/debugging-and-testing/instrumentation",
595595
title: "Instrumentation",
596+
children: [
597+
{
598+
type: "ref",
599+
path: "/resources/integrations/guides/sentry",
600+
title: "Guide: Sentry",
601+
},
602+
],
596603
},
597604
{
598605
type: "link",

www/apps/resources/app/integrations/guides/algolia/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ export async function POST(
692692
}
693693
```
694694

695-
Since you export a `POST` route handler function, you expose an `API` route at `/admin/algolia/sync`. The route handler function accepts two parameters:
695+
Since you export a `POST` route handler function, you expose a `POST` API route at `/admin/algolia/sync`. The route handler function accepts two parameters:
696696

697697
1. A request object with details and context on the request, such as body parameters or authenticated user details.
698698
2. A response object to manipulate and send the response.

0 commit comments

Comments
 (0)