Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup and more Readme #2

Merged
merged 7 commits into from
Sep 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,58 @@
# Table of Contents

* [Features](#features)
* [Performance](#performance)
* [Installation](#installation)
* [Configuration](#configuration)
* [Changelog](#changelog)
* [Disclaimer](#disclaimer)

# bna2graphite

A tool to retrieve Performance counters from Brocade Network Advisor REST API and write them to a Carbon/Graphite backend.
A tool to retrieve Broadcom (former Brocade) SAN Switch Performance counters from Brocade Network Advisor REST API and write them to a Carbon/Graphite backend.
* Written in Perl.
* Tested on RHEL / CentOS 7
* tested on RHEL / CentOS 7
* works with BNA 14.4
* RPM package available

## Features
* Add one or more BNA server instances
* configurable retrival time
* configurable retrieval time
* configurable metrics
* Workers run as systemd service

## Installation
Install on RHEL via RPM package: `yum install bna2graphite-0.x.x.rpm`

Perl dependencies that are not available in RHEL / CentOS 7 repositories:
* Log::Log4perl (RPM perl-Log-Log4perl available in [EPEL repository](https://fedoraproject.org/wiki/EPEL))
* Systemd::Daemon (included in the release package, [view in CPAN](https://metacpan.org/pod/Systemd::Daemon))

For other Linux distributions you can just clone the repository. Default installation folder is `/opt/bna2graphite`. The service operates with a user called "openiomon"

## Configuration
1. Edit the `/opt/bna2graphite/conf/bna2graphite.conf`, settings you have to edit for a start:

## Changelog
* Specifiy the connection parameter to the BNA server
`[BNA]`
`<Server name>;<User name>;<Password>`

* Specify the connection to your carbon/graphite backend
`[graphite]`
`host = 127.0.0.1`
`port = 2003`

2. Create a service
`/opt/bna2graphite/bin/bna2graphite.pl -register <Server name>`

3. Enable the service
`/opt/bna2graphite/bin/bna2graphite.pl -enable <Server name>`

4. Start the service
`/opt/bna2graphite/bin/bna2graphite.pl -start <Server name>`

## Changelog
### 0.2.5
* First public release

# Disclaimer
This source and the whole package comes without warranty. It may or may not harm your computer. Please use with care. Any damage cannot be related back to the author.
This source and the whole package comes without warranty. It may or may not harm your computer. Please use with care. Any damage cannot be related back to the author.
Loading