https://github.com/zebrium/ze-cli
Zebrium's command line interface for uploading log events for automated anomaly detection.
https://github.com/zebrium/ze-cli
anomaly-detection log-analytics log-collector log-management structured-data
Last synced: 3 months ago
JSON representation
Zebrium's command line interface for uploading log events for automated anomaly detection.
- Host: GitHub
- URL: https://github.com/zebrium/ze-cli
- Owner: zebrium
- Created: 2019-08-27T18:13:59.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T14:27:56.000Z (over 1 year ago)
- Last Synced: 2024-07-31T17:29:27.764Z (over 1 year ago)
- Topics: anomaly-detection, log-analytics, log-collector, log-management, structured-data
- Language: Go
- Homepage:
- Size: 423 KB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# ZE CLI Tool
`ze` is Zebrium's command line interface for uploading log events from files or streams. Please visit the official [ScienceLogic's docs page](https://docs.sciencelogic.com/zebrium/latest/Content/Web_Zebrium/03_Log_Collectors_Uploads/File_Uploads_ze.html) for the full documentation.
## Getting Started
### Installing
* Download the corresponding release from the releases [page](https://github.com/zebrium/ze-cli/releases)
* Unzip the downloaded file in
* Set up your path in your shell config to include the new binary
* Start a new terminal and test your installation
`ze -v`
## Configuration
The ze cli tool supports a variety of ways to set its parameters. All parameters are
settable via args. To find out the args available and required for each call, use `ze -help`
or `ze -help` When leveraging the configuration file or ENV variables, ze cli will use the following
precedence: Config File -> Env Files -> Command Line Args
### Configuration File
The ze cli tool does support setting global variables in a .ze file for easy
configuration. The default location of this is `$HOME/.ze`, however this can overridden
with passing a new path with the `--config` option. The contents of that file is as follows:
``` bash
auth: XXXXXXXXXX
url: https://cloud.zebrium.com
```
### Environment Variables
The ze cli supports setting the following env variables
``` bash
ZE_AUTH: XXXXXXXXXXXX
ZE_URL: https://cloud.zebrium.com
```
## Upload Commands
The ze up command is used to upload log event data to your Zebrium instance from a file or stream (STDIN) with appropriate metadata. To see a full list of upload options, please run the command:
```bash
ze up --help
```
Example Usages:
Ingest three log files associated with the same support case "sr12345" (does not assume a .ze configuration file exists):
```ze up --file=/casefiles/sr12345/messages.log --svcgrp=sr12345 --host=node01 --log=messages --url= --auth=```
```ze up --file=/casefiles/sr12345/application.log --svcgrp=sr12345 --host=node01 --log=application --url= --auth=```
```ze up --file=/casefiles/sr12345/db.log --svcgrp=sr12345 --host=db01 --log=db --url= --auth=```
Ingest a continuous tail of /var/log/messages. When reading from a stream, such as STDIN, rather than from a file, ze requires the –log flag (assumes a .ze configuration file exists):
```tail -f /var/log/messages | ze up --log=varlogmsgs --svcgrp=monitor01 --host=mydbhost```
## Batch Commands
Please see [zebrium batch documentation](ze_batch_uploads.md)
## Migrating from the perl based ze-cli
The existing perl based application can be found [here](/legacy/bin)
### .zerc file
The .zerc file is now replaced with a .ze file that accepts the configuration
in yaml. This is described [here](#configuration-file) This means that configs that was specified as
```text
url=
auth=
```
will now need to be
```yaml
url:
auth:
```
### ENV Variables
We now support setting env variables. currently we support the following list:
```text
ZE_URL =
ZE_AUTH =
```
## Issues
If you are having issues or need assistance with your Zebrium deployment or POC, please reach out to If you are reporting a bug in the software, then feel free to open an issues on this repository For Security Issues, please see [SECURITY.md](SECURITY.md)
## Contributors
* Braeden Earp (ScienceLogic)