/community_sdk_golang

Golang libraries - SDK

Primary LanguageGoApache License 2.0Apache-2.0

community_sdk_golang

This repository is the Kentik Go SDK for the community.

kentikapi package contains Go client library for Kentik REST API

Installation

Install the library:

go get github.com/kentik/community_sdk_golang/kentikapi

Usage examples

Library usage examples are located in examples directory. Note that they are placed in Go test files (e.g. users_example_test.go) to be easily runnable.

Run an example:

export KTAPI_AUTH_EMAIL=<your kentik api credentials email>
export KTAPI_AUTH_TOKEN=<your kentik api credentials token>

# Run from the repository root
go test -tags examples -count 1 -v ./examples/users_example_test.go

Development

Run tests: go test ./...

Run all tests, including usage examples: go test -tags examples ./...

Install linters runner: golangci-lint local installation
Run golangci-lint: golangci-lint run ./...

Development state

Implemented API resources:

  • users
  • sites
  • tags
  • devices (with interfaces)
  • device labels
  • custom dimensions (with populators)
  • custom applications
  • saved filters
  • my kentik portal
  • query methods
  • plans
  • alerts
  • alerts active