Skip to content

Commit

Permalink
docs: Minor updates for Dashboard V.2 (#12170)
Browse files Browse the repository at this point in the history
* docs: Remove reference to deprecated features

* docs: Add header to Node.js section

* docs: Clarifying provider types in Dashboard v.2

* docs: Adding clarifying on log collection
  • Loading branch information
skierkowski committed Sep 20, 2023
1 parent 8292d7c commit c5b6e41
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 197 deletions.
29 changes: 0 additions & 29 deletions docs/guides/cicd/notifications.md

This file was deleted.

8 changes: 3 additions & 5 deletions docs/guides/monitoring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,11 @@ Serverless Framework, when configured to connect to the dashboard, will automati
- AWS Spans
- HTTP Spans

**Lambda Log Collection**
Serverless Framework will enable log collection by adding a CloudWatch Logs Subscription to send logs to Serverless Framework Dashboard for processing. This is used for generating Metrics, Alerts, and Traces.

Serverless Framework will enable log collection by adding a CloudWatch Logs Subscription to send logs that match a particular pattern to our infrastructure for processing. This is used for generating metrics and alerts.
Additionally, Serverless Framework will also create an IAM role in your account that allows Serverless Framework Dashboard access the CloudWatch Log Groups that are created in the Service being deployed. This is used to display the CloudWatch logs error details views alongside the stack trace.

When deploying, Serverless Framework will also create an IAM role in your account that allows the Serverless Framework backend access the CloudWatch Log Groups that are created in the Service being deployed. This is used to display the CloudWatch logs error details views alongside the stack trace.

## Disabling log collection
### Disabling log collection

If you wish to disable log collection, simply add this to `serverless.yml`.

Expand Down
47 changes: 0 additions & 47 deletions docs/guides/monitoring/alerts.md

This file was deleted.

110 changes: 0 additions & 110 deletions docs/guides/monitoring/notifications.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/guides/providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ To use providers you must add the providers to your organization and then link t

### Adding providers to your organization

To add a provider to your organization go the **org** section of the [dashboard](https://app.serverless.com). Under the **providers** tab, click **add** and follow the instructions.

You’ll be able to select the provider, like AWS, Stripe, and Twilio, name the provider, and set the credentials.
To add a provider to your organization go the **Org Settings** section of the [dashboard](https://app.serverless.com). Under the **Providers** tab, click **Add** and follow the instructions.

It is recommended that you deploy your Serverless Framework apps to different accounts for each stage. To accomplish this we recommend adding a `dev` and `prod` provider to decouple the prod environment from all other environments.

Expand Down
2 changes: 2 additions & 0 deletions docs/guides/sdk/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ layout: Doc

<!-- DOCS-SITE-LINK:END -->

# Node.js SDK

Serverless Dashboard, when Instrumentation is enabled on an AWS Lambda function,
will hook into the AWS Lambda runtime environment and automatically report
metrics, traces, spans, and events. To capture handled errors, warnings, and to
Expand Down
3 changes: 0 additions & 3 deletions docs/menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -446,10 +446,8 @@
"Overview": "guides/dashboard",
"Monitoring": {
"Overview": "guides/monitoring",
"Alerts": "guides/monitoring/alerts",
"Instrumentation": "guides/monitoring/instrumentation",
"Metrics": "guides/monitoring/metrics",
"Notifications": "guides/monitoring/notifications",
"Trace Explorer": "guides/monitoring/trace-explorer"
},
"Outputs": "guides/output-variables",
Expand All @@ -462,7 +460,6 @@
"Custom Scripts": "guides/cicd/custom-scripts",
"Testing": "guides/cicd/running-tests",
"Private Packages": "guides/cicd/private-packages",
"Notifications": "guides/cicd/notifications",
"Mono Repos": "guides/cicd/mono-repo",
"Deploy in your own CI/CD": "guides/cicd/running-in-your-own-cicd",
"Best Practices": "guides/cicd/best-practices",
Expand Down

0 comments on commit c5b6e41

Please sign in to comment.