@dendro-monitoring/dendro
v0.1.2
Published
This is the CLI for Dendro. Dendro is an open-source, serverless monitoring framework for small, distributed applications. Stream logs and metrics from your various servers to a central time-series store.
Downloads
12
Readme
Dendro
Bundled CLI and exploration platform/server for Dendro
Usage
$ npm install -g @dendro-monitoring/dendro
$ dendro COMMAND
running command...
$ dendro (-v|--version|version)
@dendro-monitoring/dendro/0.1.2 darwin-x64 node-v12.18.1
$ dendro --help [COMMAND]
USAGE
$ dendro COMMAND
...
Getting started
To get started, install Dendro using:
$ npm i -g @dendro-monitoring/dendro
Then run dendro configure
to select which services you want to monitor. Here you will be prompted to input any neccessary credentials.
To deploy the AWS cloud pipeline, run:
$ dendro deploy
Lets now verify our deployment using:
$ dendro list
Next, you need to install our log and metric collector Vector. We've provided a command to help you do this:
$ dendro install-vector
Now, lets begin sending off logs and metrics to the pipeline using:
$ ./vector --config=./vector-config.toml
Now that we have data being processed by the pipeline and being stored into the database, let's now visualize it. Run dendro start:server
and point your browser to http://localhost:3000/
And finally to clean up, run:
$ dendro teardown
Commands
dendro clean
dendro configure
dendro deploy
dendro help [COMMAND]
dendro install-vector
dendro list
dendro review [FILE]
dendro start:server
dendro teardown
dendro update
dendro clean
Removes the existing cache from disk
USAGE
$ dendro clean
OPTIONS
-L, --level=debug|info|warn|error|fatal [default: info] set the log level
-h, --help show CLI help
See code: src/commands/clean.ts
dendro configure
Configure Vector to monitor services and log sources
USAGE
$ dendro configure
OPTIONS
-L, --level=debug|info|warn|error|fatal [default: info] set the log level
-h, --help show CLI help
See code: src/commands/configure.ts
dendro deploy
Deploy the dendro logging pipeline on AWS. Run [33m[1mconfigure[22m[39m prior to this command otherwise database tables will not be set
USAGE
$ dendro deploy
OPTIONS
-L, --level=debug|info|warn|error|fatal [default: info] set the log level
-h, --help show CLI help
See code: src/commands/deploy.ts
dendro help [COMMAND]
display help for dendro
USAGE
$ dendro help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
dendro install-vector
Install Vector to collect and ship logs and metrics
USAGE
$ dendro install-vector
See code: src/commands/install-vector.ts
dendro list
List existing AWS resources
USAGE
$ dendro list
OPTIONS
-L, --level=debug|info|warn|error|fatal [default: info] set the log level
-h, --help show CLI help
See code: src/commands/list.ts
dendro review [FILE]
Pretty print the Vector config of monitored services
USAGE
$ dendro review [FILE]
OPTIONS
-h, --help show CLI help
See code: src/commands/review.ts
dendro start:server
Start dendro's dashboard for viewing live metrics
USAGE
$ dendro start:server
OPTIONS
-h, --help show CLI help
See code: src/commands/start/server.ts
dendro teardown
Permanently deletes the logging pipeline deployed on AWS
USAGE
$ dendro teardown
OPTIONS
-L, --level=debug|info|warn|error|fatal [default: info] set the log level
-h, --help show CLI help
See code: src/commands/teardown.ts
dendro update
Creates any new Timestream tables as neccessary
USAGE
$ dendro update
See code: src/commands/update.ts