checkly / checkly-go-sdk Goto Github PK

Go SDK library for use with the Checkly API

License: MIT License

Go 99.89% Makefile 0.11%

checkly go golang sdk

checkly-go-sdk's Introduction

Checkly Go SDK

This project is a Go SDK for Checkly monitoring service. It allows you to handle your checks, check groups, snippets, environments variables and everything you can do with our REST 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 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):

$ go mod init

Then, add the reference of checkly-go-sdk in a Go program using import:

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:

$ 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)

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

Create your first checks

Once you have a client, you can create a check. See here how to create your first API & Browser checks.

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 folder.

Questions

For questions and support please open a new discussion. 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 when opening an issue. Issues not conforming to the guidelines may be closed.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

License

MIT

checkly-go-sdk's People

Contributors

Stargazers

Watchers

Forkers

agilebits devillecodes kenriortega qba73 abtris

checkly-go-sdk's Issues

Add missing `omitempty` to `Dashboard` and `MaintenanceWindow`

Check with the Public API schemas, which values of PublicDashboard and MaintenanceWindow should have the omitempty flag.

story: add new Dashboard fields

Story description

Add new Dashboard fields:

favicon
link
description
checksPerPage
useTagsAndOperator

Shortcut link

https://app.shortcut.com/checkly/story/11089/add-new-dashboard-properties-to-mac

Add `frequencyInterval` field for checks

We added the frequencyInterval field to all checks payloads and we should surface this in the SDK. See the API spec at
https://www.checklyhq.com/docs/api#operation/postV1Checks

This enables users to set the sub 1-second API checks.

story: avoid the usage of pointers for CRUD methods

Change the location field on Check type

As agreed on checkly/terraform-provider-checkly#103 locations should be optional, to accomplish that we should add "omitempty" on locations field (Check Type) so if it comes empty, the default value get assigned correctly.

Add autoAssignAlerts query param to check and groups POST/PUT

We are trying to deprecate the old auto assigning of alert channels to checks. We still need to push a minor version of the go client + terraform so we can set the value to true and they don't get affected by this deprecation. The idea is that we don't assign any alert channels to a check/group automatically when no alert channel subscription is sent unless this query param is set the true

Minor code improvements

Apply some minor code improvements

no need to specifically mention the error will be non-nil, that is a well-known convention about how Golang works

// DeleteDashboard deletes the dashboard with the specified ID. It returns a
// non-nil error if the request failed.

Replace printf("%v", string(byteSlice)) with printf("%s", byteSlice)
Use t.Fail in test cases instead of t.Fatal

For more reference take a look at this PR discussion #44

story: migrate to function config pattern

https://gist.github.com/joyrexus/33d2e059ab5812ee7f0f

Add CheckResult type and functions to ListCheckResults & RetrieveCheckResult

We have a use case of the checkly sdk where we need to retrieve the last check result to update the state of the server. In order to achieve this, the following needs to be added:

A type on CheckResult to model the response of this request https://www.checklyhq.com/docs/api/#retrieve-a-check-result.
A function that makes the call to the above endpoint to retrieve a check request
A function that makes a call to the endpoint https://www.checklyhq.com/docs/api/#lists-all-check-results to retrieve a list of all check requests for a check

Add support for Triggers

Migrate test to use new User Keys with AccountID

feature: add private locations support

Add a new PrivateLocation type
Add CRUD methods
Allow private location assignments in check/groups
Add the required tests (unit & integrations)
Update docs and examples

Support `runtimeId` for checks, checkGroup

We need to allow users to read and update the runtimeId field on the check and checkGroup entities.

This is already live in public API

check: https://www.checklyhq.com/docs/api#operation/getV1Checks
checkGroup: https://www.checklyhq.com/docs/api#operation/getV1Checkgroups

This field is a string and allows a null value. When a runtimeId is null, the check uses the runtime from either the account or the check group.

Convert ChecklyClient to an interface

It is currently not possible to mock ChecklyClient since it is a struct. We should convert it to an interface so it can be used easily for testing locally

story: split code in seperate files according to types and implementations

Use standard labels, changelog and template

Release v1.5.7?

Hi,

Could you please release v1.5.7? I see an important change, which is b5ee107#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR15.

Or can you advise when the next release is expected? Sorry if it's already planned and I'm just jumping the gun.

Deprecate `SSLCertificates` and update docs

Add deprecation notice to SSLCertificates
This property is not longer used by Checkly Public API and will be removed in v2

AlertSettings field of Check struct should be a pointer value

The AlertSettings field of the Check struct is currently a struct. The result is that when this field is omitted, the resulting JSON still contains the value. This is not what the API expects or what is documented in the API docs.

This can be see here: https://play.golang.org/p/cupZglCunSx
Which prints:

{"alertSettings":{"runBasedEscalation":{},"timeBasedEscalation":{},"reminders":{},"sslCertificates":{"enabled":false,"alertThreshold":0}}}

If you were to change the AlertSettings field to a pointer type, the resulting JSON will be what's expected.

This can be seen here: https://play.golang.org/p/YbWYjwaW3RU
Which prints:

{}

This is also true for the subfields of AlertSettings:

RunBasedEscalation
TimeBasedEscalation
Reminders
SSLCertificates

Typo on example demo

Checking the demo can be detect the following typo

...
client.Debug = os.Stdout // this throw an error because Debug property are unexported

Create new methods for checks CRUD

Flag existing methods as deprecated
Add more verbose method names (with the same functionality) to be consistent with the other resources:
```
CreateCheck
UpdateCheck
DeleteCheck
GetCheck
```
Use new check create endpoints for check creation

Change main.go data for correct one

Remove local test data from demo (baseUrl and key)

Deprecate `SSLChecks` and update docs

Set `RepeatInterval` property `omitempty`

Tweak MaintenanceWindow property RepeatInterval and allow omitempty

Add check-groups API

We recently opened up the /check-groups/ endpoint in the public API. We want to start creating groups in Terraform. For this we need to expose the the check-groups endpoint in the SDK.

The implementation should address the following endpoints:

GET /v1/check-groups
POST /v1/check-groups
DELETE /v1/check-groups/{id}
GET /v1/check-groups/{id}

Support Private Locations

Add a new PrivateLocation type
Add CRUD methods
Allow private location assignments in check/groups
Add the required tests (unit & integrations)
Update docs and examples

Rename check methods

CreateCheck
GetCheck
DeleteCheck
UpdateCheck

The to and from parameters should be optional in the CheckResultsFilter

When retrieving the check results list, it returns an empty result if the from and to query parameters are not filled. However, our public API does not have that restriction: if the parameters aren't there we still get a result. The preferred functionality is that the query parameters should be added only if they are present in the CheckResultsFilter.

This was reported by @ogbuaguno in our private support channel