Skip to content
This repository has been archived by the owner on Nov 28, 2023. It is now read-only.

Latest commit

 

History

History
147 lines (113 loc) · 4.52 KB

README.md

File metadata and controls

147 lines (113 loc) · 4.52 KB
Raw

CircleCI Hex.pm

snap-plugin-publisher-signifai

Publishes snap metrics/events to SignifAI metrics service.

SignifAI is a machine intelligence platform that helps TechOps teams get to answers faster by learning from their expertise, not generic algorithims. SignifAI helps TechOps deliver more uptime by intelligently prioritizing alerts, quickly identifying the root cause of an issue and correlating all the relevant log, events and metric data associated with the issue.

  1. Getting Started
  1. Documentation
  1. Community Support
  2. Contributing
  3. License
  4. Acknowledgements

Getting Started

System Requirements

Operating systems

All OSs currently supported by snap:

  • Linux/amd64
  • Darwin/amd64

Installation

Download signifai plugin binary:

You can get the pre-built binaries for your OS and architecture under the plugin's release page. For Snap, check here.

To build the plugin binary:

Fork https://github.com/SignifAi/snap-plugin-publisher-signifai

Clone repo into $GOPATH/src/github.com/SignifAi/:

$ git clone https://github.com/<yourGithubID>/snap-plugin-publisher-signifai.git

Building

The following provides instructions for building the plugin yourself if you decided to download the source. We assume you already have a $GOPATH setup for golang development. The repository utilizes glide for library management.

build: make

testing: make test

Configuration and Usage

Load the Plugin

Once the framework is up and running, you can load the plugin.

$ snaptel plugin load snap-plugin-publisher-signifai
Plugin loaded
Name: signafai
Version: 1
Type: publisher
Signed: false
Loaded Time: Sat, 18 Mar 2017 13:28:45 PDT

Task File

You need to create or update a task file to use the signafai publisher plugin. We have provided an example, _tasks/signifai.yaml shown below. In our example, we utilize the psutil collector so we have some data to work with. There is only a single required configuration parameter:

Setting Description Required?
token The Signafai JWT token. Yes 
---
  version: 1
  schedule:
    type: "simple"
    interval: "5s"
  max-failures: 10
  workflow:
    collect:
      config:
      metrics:
        /intel/psutil/load/load1: {} 
        /intel/psutil/load/load15: {}
        /intel/psutil/load/load5: {}
        /intel/psutil/vm/available: {}
        /intel/psutil/vm/free: {}
        /intel/psutil/vm/used: {}
      publish:
        - plugin_name: "signifai-publisher"
          config:
            token: "1234ABCD"
            api: metrics
            application: Signifai

Once the task file has been created, you can create and watch the task.

$ snaptel task create -t tasks/signafai.yaml
Using task manifest to create task
Task created
ID: 72869b36-def6-47c4-9db2-822f93bb9d1f
Name: Task-72869b36-def6-47c4-9db2-822f93bb9d1f
State: Running

$ snaptel task list
ID                                       NAME
STATE     ...
72869b36-def6-47c4-9db2-822f93bb9d1f
Task-72869b36-def6-47c4-9db2-822f93bb9d1f    Running   ...

Documentation

https://docs.signifai.io

Roadmap

We keep working on more feature and will update the publisher as needed.

Community Support

Open an issue and we will respond.

Contributing We love contributions!

The most immediately helpful way you can benefit this plug-in is by cloning the repository, adding some further examples and submitting a pull request.

License

Released under the Apache 2.0 License.

Acknowledgements