Clete
  • Getting Started
    • Quickstart
  • Setup
    • User Auth
    • Organisation setup
    • Service Context setup
    • Log Monitoring Platforms
      • Heroku
      • Cloudwatch
      • Elasticsearch
  • Service Contexts
    • Context Viewer
  • Observability Machine
    • VM Provisioning
    • VM Specifications
  • Clete Binary
    • Initialization
    • Processor
    • Streamer
    • Credentials
  • Reporting
    • E-mail Alerts
Powered by GitBook
On this page
  1. Getting Started

Quickstart

NextUser Auth

Last updated 4 months ago

To start using Clete in your organisation, you need to sign up with a Github account:

Once, you are authenticated, you can setup an organisation which will require the organisation name and product choice

Once the organisation setup is done, you can provide details about the service you'd like Clete to monitor and also provide additional description about that service (known as context hereafter)

Once you click on "submit configuration", you will be redirected to another form which collects more information on the platform

Under platform type, you specify if the platform your service is hosted on which could be Data, Compute, Monitoring etc and the environment could be either development, staging, and production

Next, you specify the dependencies and on-call contacts.

Once you are done with service configuration, you can connect to your a virtual machine by clicking the "observability machine" button. The VM takes a few minutes to setup as it installs Clete and key dependencies.

Once the virtual machine is ready with Clete installed, you should initialize clete with the following command:

clete init

This will initialize clete to start monitoring for a service and context you've setup previously by asking for the context id and the api keys to the logging platforms.

Once initialization is done, you can run the following to allow clete properly monitoring your services

clete processor start -c <cid>
clete streamer start -c <cid>

Ensure the context id for the -c flag are the same for both streamer and processor.

Once, this is done with no errors, Clete is now monitoring your services and will notify you of potential issues. you can monitor the logs of the processor and streamer to verify they are working by running the following comands in your shell

clete processor logs -c <cid>
clete streamer logs -c <cid>

If both are working are correctly, you should expect mails like the following if any potential issues are found:

Organiosation setup view
Service Description
VM setup