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.

Usage

Note: the lastest version of the API (1.3) is not backwards compatible with previous versions, specifically the client entrypoint names have changed to prevent naming conflicts. Use UsersClient (Users API) ,SubaccountClient (Sub-accounts API), AlertsClient (Alerts API) and EndpointsClient (Endpoints API) rather than Users, Alerts and Endpoints.

Alerts V2

To create an alert where the type field = 'mytype' and the loglevel field = ERROR, see the logz.io docs for more info

https://support.logz.io/hc/en-us/articles/209487329-How-do-I-create-an-Alert-

client, _ := alerts_v2.New(apiToken, apiServerAddress)
alertQuery := alerts_v2.AlertQuery{
		Query:                    "loglevel:ERROR",
		Aggregation:              alerts_v2.AggregationObj{AggregationType: alerts_v2.AggregationTypeCount},
		ShouldQueryOnAllAccounts: true,
	}

	trigger := alerts_v2.AlertTrigger{
		Operator:               alerts_v2.OperatorEquals,
		SeverityThresholdTiers: map[string]float32{alerts_v2.SeverityHigh: 10, alerts_v2.SeverityInfo: 5},
	}
	
	subComponent := alerts_v2.SubAlert{
		QueryDefinition: alertQuery,
		Trigger:         trigger,
		Output:          alerts_v2.SubAlertOutput{},
	}

	createAlertType := alerts_v2.CreateAlertType{
		Title:                  "test create alert",
		Description:            "this is my description",
		Tags:                   []string{"some", "words"},
		Output:                 alerts_v2.AlertOutput{},
		SubComponents:          []alerts_v2.SubAlert{subComponent},
		Correlations:           alerts_v2.SubAlertCorrelation{},
		Enabled:                strconv.FormatBool(true),
	}

alert := client.CreateAlert(createAlertType)

function	func name
Create alert	func (c *AlertsV2Client) CreateAlert(alert CreateAlertType) (*AlertType, error)
Delete alert	func (c *AlertsV2Client) DeleteAlert(alertId int64) error
Disable alert	func (c *AlertsV2Client) DisableAlert(alert AlertType) (*AlertType, error)
Enable alert	func (c *AlertsV2Client) EnableAlert(alert AlertType) (*AlertType, error)
Get alert	func (c *AlertsV2Client) GetAlert(alertId int64) (*AlertType, error)
List alerts	func (c *AlertsV2Client) ListAlerts() ([]AlertType, error)
Update alert	func (c *AlertsV2Client) UpdateAlert(alertId int64, alert CreateAlertType) (*AlertType, error)

Alerts

To create an alert where the type field = 'mytype' and the loglevel field = ERROR, see the logz.io docs for more info

https://support.logz.io/hc/en-us/articles/209487329-How-do-I-create-an-Alert-

client, _ := alerts.New(apiToken, apiServerAddress)
alert := client.CreateAlert(alerts.CreateAlertType{
    Title:       "this is my alert",
    Description: "this is my description",
    QueryString: "loglevel:ERROR",
    Filter:      "{\"bool\":{\"must\":[{\"match\":{\"type\":\"mytype\"}}],\"must_not\":[]}}",
    Operation:   alerts.OperatorGreaterThan,
    SeverityThresholdTiers: []alerts.SeverityThresholdType{
        alerts.SeverityThresholdType{
            alerts.SeverityHigh,
            10,
        },
    },
    SearchTimeFrameMinutes:       0,
    NotificationEmails:           []interface{}{},
    IsEnabled:                    true,
    SuppressNotificationsMinutes: 0,
    ValueAggregationType:         alerts.AggregationTypeCount,
    ValueAggregationField:        nil,
    GroupByAggregationFields:     []interface{}{"my_field"},
    AlertNotificationEndpoints:   []interface{}{},
})

function	func name
create alert	func (c *AlertsClient) CreateAlert(alert CreateAlertType) (*AlertType, error)
update alert	func (c *AlertsClient) UpdateAlert(alertId int64, alert CreateAlertType) (*AlertType, error)
delete alert	func (c *AlertsClient) DeleteAlert(alertId int64) error
get alert (by id)	func (c *AlertsClient) GetAlert(alertId int64) (*AlertType, error)
list alerts	func (c *AlertsClient) ListAlerts() ([]AlertType, error)

Users

To create a new user, on a specific account or sub-account. you'll need your account Id.

client, _ := users.New(apiToken, apiServerAddress)
user := client.User{
    Username:  "createa@test.user",
    Fullname:  "my username",
    AccountId: 123456,
    Roles:     []int32{users.UserTypeUser},
}

function	func name
create user	func (c *UsersClient) CreateUser(user User) (*User, error)
update user	func (c *UsersClient) UpdateUser(user User) (*User, error)
delete user	func (c *UsersClient) DeleteUser(id int32) error
get user	func (c *UsersClient) GetUser(id int32) (*User, error)
list users	func (c *UsersClient) ListUsers() ([]User, error)
suspend user	func (c *UsersClient) SuspendUser(userId int32) (bool, error)
unsuspend user	func (c *UsersClient) UnSuspendUser(userId int32) (bool, error)

Sub-accounts

To create a new sub-account, on a main account.

client, _ := sub_accounts.New(apiToken, apiServerAddress)
subaccount := sub_accounts.SubAccountCreate{
    Email:                 "test.user@email.com",
    AccountName:           "my account name",
    MaxDailyGB:            6.5,
    RetentionDays:         4,
    Searchable:            true,
    Accessible:            false,
    SharingObjectAccounts: []int32{accountId1, accountId2}, //Id's of the accounts who will be able to access this account
    DocSizeSetting:        true,
}

function	func name
create sub-account	func (c *SubAccountClient) CreateSubAccount(subAccount SubAccountCreate) (*SubAccount, error)
update sub-account	func (c *SubAccountClient) UpdateSubAccount(id int64, subAccount SubAccount) error
delete sub-account	func (c *SubAccountClient) DeleteSubAccount(id int64) error
get sub-account	func (c *SubAccountClient) GetSubAccount(id int64) (*SubAccount, error)
get detailed sub-account	func (c *SubAccountClient) GetDetailedSubAccount(id int64) (*SubAccountDetailed, error)
list sub-accounts	func (c *SubAccountClient) ListSubAccounts() ([]SubAccount, error)
list detailed sub-accounts	func (c *SubAccountClient) DetailedSubAccounts() ([]SubAccountDetailed, error)

Endpoints

For each type of endpoint there is a different structure, below you can find an example for creating a Slack endpoint. For more info, see: https://docs.logz.io/api/#tag/Manage-notification-endpoints or check our endpoints tests for more examples.

client, _ := endpoints.New(apiToken, apiServerAddress)
endpoint, err := underTest.CreateEndpoint(endpoints.Endpoint{
			Title:        "some_endpoint",
			Description:  "my description",
			Url:          "https://this.is.com/some/webhook",
			EndpointType: endpoints.EndpointTypeSlack,
		})

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.

Run tests

go test -v -race ./...

Changelog

• v1.5.2
  • Fix custom endpoint -empty headers bug.
  • Allow empty array for sharing accounts in sub account.
• v1.5.1
  • Fix alerts_v2 sort bug.
• v1.5
  • Add alerts v2 compatibility.
• v1.3.2
  • fix client custom endpoint headers bug
  • improve tests
• v1.3
  • unnecessary resource updates bug fix.
  • support tags in alerts
• v1.2
  • Add subaccount support

Documentation

Index

• func AddHttpHeaders(apiToken string, req *http.Request)
• func CheckValidStatus(response *http.Response, status []int) bool
• func Contains(slice []string, s string) bool
• func CreateHttpRequest(req *http.Request) (map[string]interface{}, error)
• func CreateHttpRequestBytesResponse(req *http.Request) ([]byte, error)

Functions

func AddHttpHeaders

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

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]interface{}, error)

func CreateHttpRequestBytesResponse

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