Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/checkly/checkly-go-sdk
Go SDK library for use with the Checkly API
https://github.com/checkly/checkly-go-sdk
checkly go golang sdk
Last synced: about 2 months ago
JSON representation
Go SDK library for use with the Checkly API
- Host: GitHub
- URL: https://github.com/checkly/checkly-go-sdk
- Owner: checkly
- License: mit
- Created: 2020-05-12T17:43:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T11:01:40.000Z (6 months ago)
- Last Synced: 2024-07-05T17:13:43.732Z (6 months ago)
- Topics: checkly, go, golang, sdk
- Language: Go
- Homepage:
- Size: 308 KB
- Stars: 17
- Watchers: 10
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Checkly Go SDK
[](https://github.com/checkly/checkly-go-sdk/actions/workflows/test.yml)
[](http://godoc.org/github.com/checkly/checkly-go-sdk)
[](https://goreportcard.com/report/github.com/checkly/checkly-go-sdk)
This project is a Go SDK for [Checkly](https://checklyhq.com/?utm_source=github&lmref=1374) monitoring service. It allows you to handle your checks, check groups, snippets, environments variables and everything you can do with our [REST API](https://www.checklyhq.com/docs/api).
## Installation
To use the client library with your Checkly account, you will need an API Key for the account. Go to the [Account Settings: API Keys page](https://app.checklyhq.com/account/api-keys) and click 'Create API Key'.
Make sure your project is using Go Modules (it will have a go.mod file in its root if it already is):
```bash
$ go mod init
```
Then, add the reference of checkly-go-sdk in a Go program using `import`:
```go
import checkly "github.com/checkly/checkly-go-sdk"
```
Run any of the normal go commands (`build/install/test`) and the Go toolchain will resolve and fetch the checkly-go-sdk module automatically.
Alternatively, you can also explicitly go get the package into a project:
```bash
$ go get -u github.com/checkly/checkly-go-sdk
```
## Getting Started
Create a new checkly `Client` by calling `checkly.NewClient()` (you will need to set your Checkly API Key and Account ID)
```go
baseUrl := "https://api.checklyhq.com"
apiKey := os.Getenv("CHECKLY_API_KEY")
accountId := os.Getenv("CHECKLY_ACCOUNT_ID")
client := checkly.NewClient(
baseUrl,
apiKey,
nil, //custom http client, defaults to http.DefaultClient
nil, //io.Writer to output debug messages
)
client.SetAccountId(accountId)
```
> Note: if you don't have an API key, you can create one at [here](https://app.checklyhq.com/account/api-keys)
### Create your first checks
Once you have a client, you can create a check. See here how to create your first API & Browser checks.
```go
apiCheck := checkly.Check{
Name: "My API Check",
Type: checkly.TypeAPI,
Frequency: 5,
Activated: true,
Locations: []string{
"eu-west-1",
"ap-northeast-2",
},
Tags: []string{ "production" },
Request: checkly.Request{
Method: http.MethodGet,
URL: "https://api.checklyhq.com/v1",
},
}
browserCheck := checkly.Check{
Name: "My Browser Check",
Type: checkly.TypeBrowser,
Frequency: 5,
Activated: true,
Locations: []string{"eu-west-1"},
Script: `const assert = require("chai").assert;
const puppeteer = require("puppeteer");
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto("https://example.com");
const title = await page.title();
assert.equal(title, "Example Site");
await browser.close();`,
}
ctx := context.WithTimeout(context.Background(), time.Second * 5)
client.CreateCheck(ctx, apiCheck)
client.CreateCheck(ctx, browserCheck)
```
> A complete example program! You can see an example program which creates a Checkly check in the [demo](demo/main.go) folder.
## Questions
For questions and support please open a new [discussion](https://github.com/checkly/checkly-go-sdk/discussions). The issue list of this repo is exclusively for bug reports and feature/docs requests.
## Issues
Please make sure to respect issue requirements and choose the proper [issue template](https://github.com/checkly/checkly-go-sdk/issues/new/choose) when opening an issue. Issues not conforming to the guidelines may be closed.
## Contribution
Please make sure to read the [Contributing Guide](https://github.com/checkly/checkly-go-sdk/blob/main/CONTRIBUTING.md) before making a pull request.
## License
[MIT](https://github.com/checkly/checkly-go-sdk/blob/main/LICENSE)