Skip to content

Commit adec9f4

Browse files
authored
Updating Thundra docs and adding link to channel (sst#1373)
1 parent 3f28e74 commit adec9f4

File tree

5 files changed

+43
-31
lines changed

5 files changed

+43
-31
lines changed

www/config.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ module.exports = {
22
email: "hello@serverless-stack.com",
33
home: "https://serverless-stack.com/",
44
guide: "https://serverless-stack.com/#guide",
5+
slack: "https://serverless-stack.slack.com/",
56
twitter: "https://twitter.com/ServerlessStack",
6-
slack: "https://serverless-stack.com/slack",
77
forum: "https://discourse.serverless-stack.com/",
8+
slack_invite: "https://serverless-stack.com/slack",
89
newsletter: "https://serverless-stack.com/newsletter.html",
910
examples: "https://serverless-stack.com/examples/index.html",
1011
github: "https://github.com/serverless-stack/serverless-stack",

www/docs/about.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ npx sst deploy --stage prod
6363
## Join our community
6464

6565
<div className={styles.communityPanels}>
66-
<a className={styles.communityPanel} href={ config.slack }>
66+
<a className={styles.communityPanel} href={ config.slack_invite }>
6767
<div className={styles.communityPanelIconSlack}>
6868
<i className="fab fa-slack"></i>
6969
</div>

www/docs/advanced/monitoring.md

+38-27
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Monitoring
33
description: "Learn how to use services like Datadog, Sentry, Epsagon, and Lumigo to monitor the Lambda functions in your SST app in production."
44
---
55

6+
import config from "../../config";
7+
68
Once your app has been [deployed to production](../going-to-production.md), it's useful to be able to monitor your Lambda functions. There are a few different services that you can use for this. We'll look at them below.
79

810
## Datadog
@@ -95,32 +97,6 @@ export const handler = Sentry.AWSLambda.wrapHandler(async (event) => {
9597

9698
For more details, [check out the Sentry docs](https://docs.sentry.io/platforms/node/guides/aws-lambda/).
9799

98-
## Epsagon
99-
100-
:::caution
101-
102-
Epsagon is undergoing some changes after the acquisition by Cisco. We recommend using one of the other monitoring services.
103-
104-
:::
105-
106-
[Epsagon](https://epsagon.com) is an end-to-end [Application Monitoring Service](https://epsagon.com/) and can monitor the full lifecycle of your serverless requests.
107-
108-
The Epsagon docs on [using a Lambda Layer](https://docs.epsagon.com/docs/getting-started/monitoring-applications/aws-lambda-layer) are incorrect. You'll need to install the Epsagon agent for your Lambda functions.
109-
110-
``` bash
111-
npm install epsagon
112-
```
113-
114-
And wrap your Lambda functions with their tracing wrapper.
115-
116-
``` js
117-
const handler = epsagon.lambdaWrapper(function(event, context) {
118-
// Lambda code
119-
});
120-
121-
export { handler };
122-
```
123-
124100
## Lumigo
125101

126102
[Lumigo](https://lumigo.io) offers a [Serverless Monitoring and Debugging Platform](https://lumigo.io/).
@@ -153,6 +129,10 @@ For more details, [check out the Lumigo docs on auto-tracing](https://docs.lumig
153129

154130
To get started, [sign up for an account](https://console.thundra.io/landing/). Then [follow the steps in the quick start guide](https://apm.docs.thundra.io/getting-started/quick-start-guide/connect-thundra) to deploy their stack into the AWS account you wish to monitor.
155131

132+
:::info
133+
Need help setting up? <a href={ config.slack_invite }>Join us on Slack</a> and head over to the <a href={ `${config.slack}app_redirect?channel=thundra` }>#thundra</a> channel. The Thundra team is ready to help.
134+
:::
135+
156136
To enable Lambda monitoring, you'll need to add a layer to the functions you want to monitor. To figure out the layer ARN for the latest version, [check the badge here](https://apm.docs.thundra.io/node.js/nodejs-integration-options).
157137

158138
With the layer ARN, you can use the layer construct in your CDK code.
@@ -183,8 +163,13 @@ if (!scope.local) {
183163
}
184164
```
185165

186-
For more details, [check out the Thundra docs](https://apm.docs.thundra.io/).
166+
For more details, [check out the Thundra docs](https://apm.docs.thundra.io/node.js/nodejs-integration-options).
187167

168+
#### Time Travel Debugging
169+
170+
Thudra also offers a feature called [Time Travel Debugging (TTD)](https://apm.docs.thundra.io/debugging/offline-debugging) that makes it possible to travel back in time to previous states of your application by getting a snapshot of when each line is executed. You can step over each line of the code and track the values of the variables captured during execution.
171+
172+
To enable TTD in your SST app, you'll need to modify the esbuild config. [Check out the Thundra docs on this](https://apm.docs.thundra.io/node.js/ttd-time-travel-debugging-for-nodejs#using-with-sst).
188173

189174
## New Relic
190175

@@ -214,3 +199,29 @@ if (!scope.local) {
214199
});
215200
}
216201
```
202+
203+
## Epsagon
204+
205+
:::caution
206+
207+
Epsagon is undergoing some changes after the acquisition by Cisco. We recommend using one of the other monitoring services.
208+
209+
:::
210+
211+
[Epsagon](https://epsagon.com) is an end-to-end [Application Monitoring Service](https://epsagon.com/) and can monitor the full lifecycle of your serverless requests.
212+
213+
The Epsagon docs on [using a Lambda Layer](https://docs.epsagon.com/docs/getting-started/monitoring-applications/aws-lambda-layer) are incorrect. You'll need to install the Epsagon agent for your Lambda functions.
214+
215+
``` bash
216+
npm install epsagon
217+
```
218+
219+
And wrap your Lambda functions with their tracing wrapper.
220+
221+
``` js
222+
const handler = epsagon.lambdaWrapper(function(event, context) {
223+
// Lambda code
224+
});
225+
226+
export { handler };
227+
```

www/docs/design-principles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ cron.attachPermissions([
125125

126126
### Having an escape hatch
127127

128-
We are continually working to improve the design of the SST constructs. Feel free to send us your feedback <a href={ config.slack }>via Slack</a> or <a href={ `mailto:${config.email}` }>email</a>.
128+
We are continually working to improve the design of the SST constructs. Feel free to send us your feedback <a href={ config.slack_invite }>via Slack</a> or <a href={ `mailto:${config.email}` }>email</a>.
129129

130130
That said, you might run into cases where you are trying to do something that these constructs do not support. In these cases, you can fallback to using the native CDK constructs instead. This _escape hatch_ ensures that you won't be locked in to using SST's constructs.
131131

www/docs/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ SST has a couple of defaults, like a built-in linter, type checker, and bundler.
5959

6060
You can disable the linter, provide your own TypeScript config, and disable bundling. You also don't have to use the higher-level constructs that SST has and just use the native CDK ones.
6161

62-
If you hit a limitation, feel free to hop into our <a href={ config.slack } target="\_blank">Slack community</a> and let us know about it.
62+
If you hit a limitation, feel free to hop into our <a href={ config.slack_invite } target="\_blank">Slack community</a> and let us know about it.
6363

6464
### Why does SST not use CDK's built-in way to build Node.js functions?
6565

0 commit comments

Comments
 (0)