jolokia

README

Telegraf plugin: Jolokia

Plugin arguments:

• context string: Context root used of jolokia url
• servers []Server: List of servers
  • name string: Server's logical name
  • host string: Server's ip address or hostname
  • port string: Server's listening port
• metrics []Metric
  • name string: Name of the measure
  • jmx string: Jmx path that identifies mbeans attributes
  • pass []string: Attributes to retain when collecting values
  • drop []string: Attributes to drop when collecting values

Description

The Jolokia plugin collects JVM metrics exposed as MBean's attributes through jolokia REST endpoint. All metrics are collected for each server configured.

See: https://jolokia.org/

Measurements:

Jolokia plugin produces one measure for each metric configured, adding Server's name, host and port as tags.

Given a configuration like:

[jolokia]

[[jolokia.servers]]
  name = "as-service-1"
  host = "127.0.0.1"
  port = "8080"

[[jolokia.servers]]
  name = "as-service-2"
  host = "127.0.0.1"
  port = "8180"

[[jolokia.metrics]]
  name = "heap_memory_usage"
  jmx  = "/java.lang:type=Memory/HeapMemoryUsage"
  pass = ["used", "max"]

The collected metrics will be:

jolokia_heap_memory_usage name=as-service-1,host=127.0.0.1,port=8080 used=xxx,max=yyy
jolokia_heap_memory_usage name=as-service-2,host=127.0.0.1,port=8180 used=vvv,max=zzz

Documentation

Index

• type Jolokia
  • func (j *Jolokia) Description() string
  • func (j *Jolokia) Gather(acc plugins.Accumulator) error
  • func (j *Jolokia) SampleConfig() string
• type JolokiaClient
• type JolokiaClientImpl
  • func (c JolokiaClientImpl) MakeRequest(req *http.Request) (*http.Response, error)
• type Metric
• type Server

Types

type Jolokia

type Jolokia struct {
	Context string
	Servers []Server
	Metrics []Metric
	Tags    map[string]string
	// contains filtered or unexported fields
}

func (*Jolokia) Description

func (j *Jolokia) Description() string

func (*Jolokia) Gather

func (j *Jolokia) Gather(acc plugins.Accumulator) error

func (*Jolokia) SampleConfig

func (j *Jolokia) SampleConfig() string

type JolokiaClient

type JolokiaClient interface {
	MakeRequest(req *http.Request) (*http.Response, error)
}

type JolokiaClientImpl

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

func (JolokiaClientImpl) MakeRequest

func (c JolokiaClientImpl) MakeRequest(req *http.Request) (*http.Response, error)

type Metric

type Metric struct {
	Name string
	Jmx  string
	Pass []string
	Drop []string
}

type Server

type Server struct {
	Name string
	Host string
	Port string
}