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

Latest commit

 

History

History
101 lines (76 loc) · 3.8 KB

README.md

File metadata and controls

101 lines (76 loc) · 3.8 KB

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

Snap Hawkular publisher plugin

This plugin publishes snap metric data into Hawkular.

It's used in the snap framework.

  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 cassandra publisher plugin binary:

You can get the pre-built binaries for your OS and architecture at snap's Github Releases page.

Building from source

  • Get the package: go get github.com/intelsdi-x/snap-plugin-publisher-hawkular
  • Build the snap-plugin-publisher-kawkular plugin
  1. From the root of the snap-plugin-publisher-hawkular path type make all.
  • This builds the plugin in /build/[GOOS]/[GOARCH].

Install Cassandra

  • install Cassandra
 docker run -d --name snapcass -e CASSANDRA_START_RPC=true cassandra:3.0.9
  • install Hawkular services
 docker run -d --name snaphawk --link=snapcass -e CASSANDRA_NODES=snapcass -p 8080:8080 -e ADMIN_TOKEN=topsecret hawkular/hawkular-services:latest

Documentation

The plugin expects you to provide the following parameters:

  • server the hawkular server name or ip address.

You can also set the following options if needed:

  • tenant defaults to snap. It's required by hawkular.
  • user defaults to jdoe (string).
  • password defaults to password (string).
  • port the hawkular server port. it defaults to 8080.
  • insecureSkipVerify defaults to true (bool).
  • scheme defaults to http (string).

Examples

See examples/tasks folder for examples.

Roadmap

This plugin is still in active development. As we launch this plugin, we have a few items in mind for the next few releases:

  • Additional error handling
  • Large test

If you have a feature request, please add it as an issue and/or submit a pull request.

Community Support

This repository is one of many plugins in snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap.

To reach out to other users, head to the main framework.

Contributing

We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.

License

snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.

Acknowledgements

And thank you! Your contribution, through code and participation, is incredibly important to us.