Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andygrunwald/cachet
Go(lang) client library for Cachet (open source status page system).
https://github.com/andygrunwald/cachet
Last synced: about 2 months ago
JSON representation
Go(lang) client library for Cachet (open source status page system).
- Host: GitHub
- URL: https://github.com/andygrunwald/cachet
- Owner: andygrunwald
- License: mit
- Created: 2015-10-31T12:30:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-22T17:03:41.000Z (over 3 years ago)
- Last Synced: 2024-10-12T21:15:40.067Z (2 months ago)
- Language: Go
- Size: 74.2 KB
- Stars: 91
- Watchers: 8
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - cachet - Go client library for [Cachet (open source status page system)](https://cachethq.io/). (Third-party APIs / Utility/Miscellaneous)
- awesome-go - cachet - Go(lang) client library for Cachet (open source status page system). - ★ 57 (Third-party APIs)
- awesome-go-extra - cachet - 10-31T12:30:07Z|2021-06-22T17:03:41Z| (Third-party APIs / Fail injection)
README
# cachet
[](https://godoc.org/github.com/andygrunwald/cachet)
[](https://travis-ci.org/andygrunwald/cachet)
[](https://goreportcard.com/report/github.com/andygrunwald/cachet)
[Go(lang)](https://golang.org/) client library for [Cachet (open source status page system)](https://cachethq.io/).
## Features
* Full API support
* Components
* Incidents
* Metrics
* Subscribers
* Various authentication methods (Basic Auth and Token based)
* Fully tested
## Installation
It is go gettable
$ go get github.com/andygrunwald/cachet
(optional) to run unit / example tests:
$ cd $GOPATH/src/github.com/andygrunwald/cachet
$ go test -v ./...
## API
Please have a look at the [GoDoc documentation](https://godoc.org/github.com/andygrunwald/cachet) for a detailed API description.
### Authentication
Cachet supports [two different ways](https://docs.cachethq.io/docs/api-authentication) for authentication: BasicAuth and API Token.
Both are supported by this library.
For BasicAuth you need to call the AuthenticationService and apply your email address and your password:
```go
client.Authentication.SetBasicAuth("[email protected]", "test123")
```
To use the API Token way, you do nearly the same but use the `SetTokenAuth` function:
```go
client.Authentication.SetTokenAuth("MY-SECRET-TOKEN")
```
## Examples
Further a few examples how the API can be used.
A few more examples are available in the [GoDoc examples section](https://godoc.org/github.com/andygrunwald/cachet#pkg-examples).
### Ping
Call the [API test endpoint](https://docs.cachethq.io/reference#ping). Example without error handling.
Full example available in the [GoDoc examples section](https://godoc.org/github.com/andygrunwald/cachet#pkg-examples).
```go
package main
import (
"fmt"
"github.com/andygrunwald/cachet"
)
func main() {
client, _ := cachet.NewClient("https://demo.cachethq.io/", nil)
pong, resp, _ := client.General.Ping()
fmt.Printf("Result: %s\n", pong)
fmt.Printf("Status: %s\n", resp.Status)
// Output: Result: Pong!
// Status: 200 OK
}
```
### Create a new component
Calling [/components](https://docs.cachethq.io/reference#components). Example without error handling.
Full example available in the [GoDoc examples section](https://godoc.org/github.com/andygrunwald/cachet#pkg-examples).
```go
package main
import (
"fmt"
"github.com/andygrunwald/cachet"
)
func main() {
client, _ := cachet.NewClient("https://demo.cachethq.io/", nil)
client.Authentication.SetBasicAuth("[email protected]", "test123")
component := &cachet.Component{
Name: "Beer Fridge",
Description: "Status of the beer fridge in the kitchen",
Status: cachet.ComponentStatusOperational,
}
newComponent, resp, _ := client.Components.Create(component)
fmt.Printf("Result: %s\n", newComponent.Name)
if newComponent.ID > 0 {
fmt.Println("ID > 0!")
}
fmt.Printf("Status: %s\n", resp.Status)
// Output: Beer Fridge
// ID > 0!
// Status: 200 OK
}
```
## Supported versions
Tested with [v1.2.1](https://github.com/cachethq/Cachet/releases/tag/v1.2.1) of Cachet.
It may works with older and / or newer versions.
Newer versions will be supported. Older versions not.
## License
This project is released under the terms of the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
## Contribution and Contact
Contribution, in any kind of way, is highly welcome!
It doesn't matter if you are not able to write code.
Creating issues or holding talks and help other people to use [cachet](https://github.com/andygrunwald/cachet) is contribution, too!
A few examples:
* Correct typos in the README / documentation
* Reporting bugs
* Implement a new feature or endpoint
* Sharing the love if [cachet](https://github.com/andygrunwald/cachet) and help people to get use to it
If you are new to pull requests, checkout [Collaborating on projects using issues and pull requests / Creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
If you've found a bug, a typo, have a question or a want to request new feature, please [report it as a GitHub issue](https://github.com/andygrunwald/cachet/issues).
For other queries, i'm available on Twitter ([@andygrunwald](https://twitter.com/andygrunwald)).