Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jsbnr authored Jul 9, 2024
1 parent 89e06eb commit 42ba664
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ The targets to test are provided by calling the function getTargets(). You can p


## Getting started (Terraform)
You can either user the terraform deployment method (detailed here) or the simpler copy and paste method (see below). The teraform deployment sets up the synhtetic monitor, secure credentials and monitoring dashbaord.

1. Checkout the repo
2. Copy `runtf.sh.sample` to `runtf.sh` and add your API keys
Expand All @@ -63,7 +64,9 @@ The application comes with a built in dashboard. Set up alerts as you require.
![dashboard-example](dashboard.png)

## Getting started (Copy and Paste)
Simply copy and paste the [`copy-paste-example.js`](./copy-paste-example.js) into a Scripted API synthetic monitor. You will need to provide an ingest API key (prefereably via a secure credential) and define your getTargets() function. Refer to the [example scripts](./terraform/targetdata/) for configuration ideas.
This is the simplest way to get started, you wil need to manualy create you synthetic monitor.

Copy and paste the [`copy-paste-example.js`](./copy-paste-example.js) into a Scripted API synthetic monitor. You will need to provide an ingest API key (prefereably via a secure credential) and define your getTargets() function. Refer to the [example scripts](./terraform/targetdata/) for configuration ideas.


## Alerting
Expand Down

0 comments on commit 42ba664

Please sign in to comment.