logzio_client

README

Logz.io Terraform client library

Client library for Logz.io API, see below for supported endpoints.

The primary purpose of this library is to act as the API interface for the logz.io Terraform provider. To use it, you'll need to create an API token and provide it to the client library along with your logz.io regional API server address.

The library currently supports the following API endpoints:

• Alerts V2.
• Users.
• Sub-accounts.
• Endpoints.
• Log shipping tokens.
• Drop filters.
• Archive logs.
• Restore logs.
• Authentication groups.
• Kibana Objects.
• S3 Fetcher.
• Grafana dashboards.
• Grafana folders.
• Grafana Alert Rules API.
• Grafana datasource.
• Grafana Notification Policy.
• Grafana Contact Point.
• Metrics Accounts
• Metrics drop filters
• Metrics roll-up rules
• Unified Alerts
• Unified Projects
• Unified Dashboards

Contributing

1. Clone this repo locally.
2. As this package uses Go modules, make sure you are outside of $GOPATH or you have the GO111MODULE=on environment variable set. Then run go get to pull down the dependencies.
3. Use logzio_client.CallLogzioApi when you need to make a Logz.io API call.
4. Use structs to represent the requests/responses body, rather than maps.
5. Sample responses for tests should be under testdata/fixtures.

Run tests

go test -v -race ./...

Trademark Disclaimer

Terraform is a trademark of HashiCorp, Inc.

Documentation

Index

• func AddHttpHeaders(apiToken string, req *http.Request)
• func CallLogzioApi(logzioCall LogzioApiCallDetails) ([]byte, error)
• func CheckValidStatus(response *http.Response, status []int) bool
• func Contains(slice []string, s string) bool
• func CreateHttpRequest(req *http.Request) (map[string]any, error)
• func CreateHttpRequestBytesResponse(req *http.Request) ([]byte, error)
• type LogzioApiCallDetails

Functions

func AddHttpHeaders

func AddHttpHeaders(apiToken string, req *http.Request)

func CallLogzioApi

func CallLogzioApi(logzioCall LogzioApiCallDetails) ([]byte, error)

func CheckValidStatus

func CheckValidStatus(response *http.Response, status []int) bool

func Contains

func Contains(slice []string, s string) bool

func CreateHttpRequest

func CreateHttpRequest(req *http.Request) (map[string]any, error)

func CreateHttpRequestBytesResponse

func CreateHttpRequestBytesResponse(req *http.Request) ([]byte, error)

Types

type LogzioApiCallDetails

type LogzioApiCallDetails struct {
	ApiToken     string
	HttpMethod   string
	Url          string
	Body         []byte
	SuccessCodes []int
	NotFoundCode int
	ResourceId   any
	ApiAction    string
	ResourceName string
}