collector

Documentation

Overview

http://www.apache.org/licenses/LICENSE-2.0.txt

Copyright 2016 Intel Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• type Plugin
  • func New() *Plugin
  • func (p *Plugin) CollectMetrics(metrics []plugin.Metric) ([]plugin.Metric, error)
  • func (p *Plugin) GetConfigPolicy() (plugin.ConfigPolicy, error)
  • func (p *Plugin) GetMetricTypes(cfg plugin.Config) ([]plugin.Metric, error)

Constants

const (
	// PluginName namespace part
	PluginName = "snmp"

	// Version of plugin
	Version = 2

	// Vendor namespace part
	Vendor = "intel"
)

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin main structure

func New

func New() *Plugin

New creates initialized instance of snmp collector

func (*Plugin) CollectMetrics

func (p *Plugin) CollectMetrics(metrics []plugin.Metric) ([]plugin.Metric, error)

CollectMetrics returns list of requested metric values It returns error in case retrieval was not successful

func (*Plugin) GetConfigPolicy

func (p *Plugin) GetConfigPolicy() (plugin.ConfigPolicy, error)

GetConfigPolicy returns config policy It returns error in case retrieval was not successful

func (*Plugin) GetMetricTypes

func (p *Plugin) GetMetricTypes(cfg plugin.Config) ([]plugin.Metric, error)

GetMetricTypes returns list of available metric types It returns error in case retrieval was not successful