An open API service indexing awesome lists of open source software.

https://github.com/logicmonitor/lm-data-sdk-java

LogicMonitor data ingestion SDK for Metric and Logs
https://github.com/logicmonitor/lm-data-sdk-java

Last synced: about 1 year ago
JSON representation

LogicMonitor data ingestion SDK for Metric and Logs

Awesome Lists containing this project

README

          

# The LogicMonitor Java Data library

---------------------------------------------------------------------------------------------------------
[![Java CI with Gradle](https://github.com/logicmonitor/lm-data-sdk-java/actions/workflows/gradle.yml/badge.svg)](https://github.com/logicmonitor/lm-data-sdk-java/actions/workflows/gradle.yml)
[![codecov](https://codecov.io/gh/logicmonitor/lm-data-sdk-java/branch/main/graph/badge.svg?token=Wz3CKLkJgA)](https://codecov.io/gh/logicmonitor/lm-data-sdk-java)

This Java Library is suitable for ingesting the metrics or logs into the LogicMonitor Platform.

## Overview

LogicMonitor's Push Metrics feature allows you to send metrics directly
to the LogicMonitor platform via a dedicated API, removing the need to
route the data through a LogicMonitor Collector. Once ingested, these
metrics are presented alongside all other metrics gathered via
LogicMonitor, providing a single pane of glass for metric monitoring and
alerting.

Similarly, If a log integration isn’t available or you have custom logs that you want to analyze,
you can send the logs directly to your LogicMonitor account via the logs ingestion API.

## Quick Start Notes:

### Use [GitHub Package](https://github.com/orgs/logicmonitor/packages?repo_name=lm-data-sdk-java)

Add the package dependencies to your build.gradle or pom.xml

#### Gradle

```groovy
dependencies {
implementation('com.logicmonitor:lm-data-sdk:0.0.6-alpha')
}
```

#### Maven

```xml

com.logicmonitor
lm-data-sdk
0.0.6-alpha

```
### Set Configurations
SDK must be configured with LogicMonitor.DataSDK Configuration class. While using LMv1 authentication set LM_ACCESS_ID and
LM_ACCESS_KEY properties, In Case of BearerToken Authentication set LM_BEARER_TOKEN property. Company's name or Account
name must be passed to LM_COMPANY property. All properties can be set using environment variable.

| Environment variable | Description |
|----------------------|:------------------------------------------------------|
| `LM_COMPANY` | Account name (Company Name) is your organization name |
| `LM_ACCESS_ID` | Access id while using LMv1 authentication. |
| `LM_ACCESS_KEY` | Access key while using LMv1 authentication. |
| `LM_BEARER_TOKEN` | BearerToken while using Bearer authentication. |
| `LM_DOMAIN_NAME` | Configure custom endpoint |

### Read the [Library Documentation](https://logicmonitor.github.io/lm-data-sdk-java/) to use Metrics/Logs ingestion API.

## Get in Touch

If you have questions in general, reach out to our [support](https://support@logicmonitor.com)

------------
Copyright, 2022, LogicMonitor, Inc.

This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL
was not distributed with this file, You can obtain
one at https://mozilla.org/MPL/2.0/.