Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change error handling mechanism #46

Merged
merged 3 commits into from
Jan 10, 2024
Merged

Change error handling mechanism #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bbe88e
change error handling mechanism
avadhut123pisal Jan 8, 2024
9174b91
update version
avadhut123pisal Jan 8, 2024
c125e8a
change useragent format
avadhut123pisal Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 87 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Similarly, If a log integration isn’t available or you have custom logs that y

## Getting Started

### Installation

To use the LogicMonitor Go Data SDK in your Go module, you can simply run the following command:

```bash
go get -u github.com/logicmonitor/lm-data-sdk-go
```

### Authentication
While using LMv1 authentication set LOGICMONITOR_ACCESS_ID and LOGICMONITOR_ACCESS_KEY properties.
In case of BearerToken authentication set LOGICMONITOR_BEARER_TOKEN property.
Expand All @@ -22,46 +30,103 @@ All properties can be set using environment variable.
| LOGICMONITOR_ACCESS_KEY | Access key while using LMv1 authentication.|
| LOGICMONITOR_BEARER_TOKEN | BearerToken while using Bearer authentication.|

## Usage

### Metrics Ingestion
Here is an [example](https://github.com/logicmonitor/lm-data-sdk-go/blob/main/example/metrics/metricsingestion.go) for metrics ingestion.

This is how you can initialise metrics client:

```go
import (
"context"
"fmt"
"os"

"github.com/logicmonitor/lm-data-sdk-go/api/metrics"
)

func main() {
options := []metrics.Option{
metrics.WithMetricBatchingInterval(3 * time.Second),
...
}

lmMetric, err := metrics.NewLMMetricIngest(context.Background(), options...)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when initializing metric client: %v\n", err)
return
}
...
}
```

Here is the complete [example](https://github.com/logicmonitor/lm-data-sdk-go/blob/main/example/metrics/metricsingestion.go) for metrics ingestion.


#### Options

Following options can be used to create the metrics api client.

| Option | Description | Default |
| -------------------- |:----------------------------------:|:--------------:|
| `WithMetricBatchingInterval(batchinterval time.Duration)` | Sets time interval to wait before performing next batching of metrics. | `10s` |
| `WithMetricBatchingDisabled()` | Disables batching of metrics. | `Enabled` |
| `WithGzipCompression(gzip bool)` | Enables / disables gzip compression of metric payload. | `Enabled` |
| `WithRateLimit(requestCount int)` | Sets limit on the number of requests to metrics API per minute. | `100` |
| `WithHTTPClient(client *http.Client)` | Sets custom HTTP Client | `Default http client with timeout of 5s`|
| `WithEndpoint(endpoint string)` | Sets endpoint to send the metrics to. | `https://${LOGICMONITOR_ACCOUNT}.logicmonitor.com/rest/`|
| `WithAuthentication(authParams utils.AuthParams)` | Sets authentication parameters | `-` |
| Option | Description |
| -------------------- |:----------------------------------:|
| `WithMetricBatchingInterval(batchinterval time.Duration)` | Sets time interval to wait before performing next batching of metrics. Default value is `10s`. |
| `WithMetricBatchingDisabled()` | Disables batching of metrics. Default value is `Enabled`. |
| `WithGzipCompression(gzip bool)` | Enables / disables gzip compression of metric payload. Default value is `Enabled`. |
| `WithRateLimit(requestCount int)` | Sets limit on the number of requests to metrics API per minute. Default value is `100`. |
| `WithHTTPClient(client *http.Client)` | Sets custom HTTP Client. Default http client is configured with timeout of `5s`.|
| `WithEndpoint(endpoint string)` | Sets endpoint to send the metrics to. Default value is `https://${LOGICMONITOR_ACCOUNT}.logicmonitor.com/rest/`.|
| `WithAuthentication(authParams utils.AuthParams)` | Sets authentication parameters. |

### Logs Ingestion
Here is an [example](https://github.com/logicmonitor/lm-data-sdk-go/blob/main/example/logs/logsingestion.go) for logs ingestion.

This is how you can initialise logs client:

```go
import (
"context"
"fmt"
"os"

"github.com/logicmonitor/lm-data-sdk-go/api/logs"
)

func main() {
options := []logs.Option{
logs.WithLogBatchingDisabled(),
...
}

lmLog, err := logs.NewLMLogIngest(context.Background(), options...)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when initializing log client: %v", err)
return
}
...
}
```

Here is the complete [example](https://github.com/logicmonitor/lm-data-sdk-go/blob/main/example/logs/logsingestion.go) for logs ingestion.


#### Options

Following options can be used to create the logs api client.


| Option | Description | Default |
| -------------------- |:---------------------------------------------:|:--------------:|
| `WithLogBatchingInterval(batchinterval time.Duration)` | Sets time interval to wait before performing next batching of logs. | `10s` |
| `WithLogBatchingDisabled()` | Disables batching of logs. | `Enabled` |
| `WithGzipCompression(gzip bool)` | Enables / disables gzip compression of metric payload. | `Enabled` |
| `WithRateLimit(requestCount int)` | Sets limit on the number of requests to metrics API per minute. | `100` |
| `WithHTTPClient(client *http.Client)` | Sets custom HTTP Client | `Default http client will have timeout of 5s`|
| `WithEndpoint(endpoint string)` | Sets endpoint to send the metrics to. | `https://${LOGICMONITOR_ACCOUNT}.logicmonitor.com/rest/`|
| `WithResourceMappingOperation(op string)` | Sets resource mapping operation. Valid operations are `AND` & `OR` | `-` |
| `WithAuthentication(authParams utils.AuthParams)` | Sets authentication parameters | `-` |

| Option | Description |
| -------------------- |:---------------------------------------------:|
| `WithLogBatchingInterval(batchinterval time.Duration)` | Sets time interval to wait before performing next batching of logs. Default value is `10s`. |
| `WithLogBatchingDisabled()` | Disables batching of logs. Default value is `Enabled`. |
| `WithGzipCompression(gzip bool)` | Enables / disables gzip compression of metric payload. Default value is `Enabled`. |
| `WithRateLimit(requestCount int)` | Sets limit on the number of requests to metrics API per minute. Default value is `100`. |
| `WithHTTPClient(client *http.Client)` | Sets custom HTTP Client. Default http client is configured with timeout of `5s`.|
| `WithEndpoint(endpoint string)` | Sets endpoint to send the metrics to. Default value is `https://${LOGICMONITOR_ACCOUNT}.logicmonitor.com/rest/`|
| `WithResourceMappingOperation(op string)` | Sets resource mapping operation. Valid operations are `AND` & `OR`. |
| `WithUserAgent(userAgent string)` | Sets user agent. |
| `WithAuthentication(authParams utils.AuthParams)` | Sets authentication parameters. |


## License

Copyright, 2023, LogicMonitor, Inc.

Expand Down
Loading
Loading