You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: plugins/Vercel/v1/docs/README.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,24 @@
1
-
#Vercel
1
+
## What this plugin monitors
2
2
3
3
Monitor your [Vercel](https://vercel.com) projects, deployments, and domains in SquaredUp. This plugin connects to the Vercel REST API to import your projects and domains as objects you can scope dashboards to, and provides data streams for deployment health and history, domain verification and expiry, team membership and activity, and a billing-based cost overview.
4
4
5
-
## What this plugin monitors
6
-
7
5
-**Projects** — your Vercel projects, including framework, git repository, and latest production deployment status. Imported as objects.
8
6
-**Domains** — custom domains, including verification status, expiry/renewal dates, and configuration health. Imported as objects.
9
-
-**Deployments** — deployment volume, success/failure rates, and history over time, account-wide or drilled down per project. (Deployments are *not* indexed as objects, because they change too frequently — they are available as data streams instead.)
7
+
-**Deployments** — deployment volume, success/failure rates, and history over time, account-wide or drilled down per project. (Deployments are _not_ indexed as objects, because they change too frequently — they are available as data streams instead.)
10
8
-**Team & activity** — team membership roster and recent account activity (events).
11
9
-**Cost** — a cost/usage overview derived from Vercel billing data (daily granularity).
12
10
-**Firewall / security** — per-project [Vercel Firewall (WAF)](https://vercel.com/docs/vercel-firewall) event activity: counts of firewall events broken down by action (e.g. allow / deny / challenge) over time. Available as data streams on the **Project** perspective's **Security** section.
13
11
14
12
The plugin ships with three out-of-the-box dashboards: an account **Overview**, a **Project** perspective (which includes a **Security** section), and a **Domain** perspective.
15
13
16
-
## Prerequisites — getting a Vercel Access Token
14
+
## Prerequisites
17
15
18
16
1. Sign in to Vercel and open **Account Settings → Tokens** (<https://vercel.com/account/tokens>).
19
17
2. Click **Create Token**.
20
18
3. Give it a name (e.g. `SquaredUp`).
21
19
4.**Scope** — choose the scope the token can access:
22
-
- To monitor a **Team**, set the scope to that team and note the team's ID or slug (see the `Team ID` field below).
23
-
- To monitor your **personal account**, scope it to your personal account.
20
+
- To monitor a **Team**, set the scope to that team and note the team's ID or slug (see the `Team ID` field below).
21
+
- To monitor your **personal account**, scope it to your personal account.
24
22
5.**Expiration** — choose an expiration (or no expiration). If the token expires, the plugin's data streams will stop returning data until you supply a new token.
25
23
6. Click **Create** and copy the token value immediately — Vercel only shows it once.
26
24
@@ -32,10 +30,10 @@ If you are monitoring a Team, open **Team Settings → General** in Vercel; the
32
30
33
31
## Configuration fields
34
32
35
-
| Field | Required | Description | Where to find it |
36
-
| --- | --- | --- | --- |
37
-
|**API Token**| Yes | The Vercel Access Token used to authenticate. Sent as a bearer token on every request. | Account Settings → Tokens (see above). |
38
-
|**Team ID**| No | The Team ID or slug to monitor. Leave blank to monitor your personal account. When set, all requests are scoped to this team. | Team Settings → General (`team_…`), or the slug in your Vercel URL. |
33
+
| Field | Required | Description | Where to find it|
|**API Token**| Yes | The Vercel Access Token used to authenticate. Sent as a bearer token on every request. | Account Settings → Tokens (see above).|
36
+
|**Team ID**| No| The Team ID or slug to monitor. Leave blank to monitor your personal account. When set, all requests are scoped to this team. | Team Settings → General (`team_…`), or the slug in your Vercel URL. |
0 commit comments