tomcat

README

tomcat

tomcat 采集器，是读取 tomcat 的管理侧接口 /manager/status/all 这个接口需要鉴权。修改 tomcat-users.xml ，增加下面的内容：

<role rolename="admin-gui" />
<user username="tomcat" password="s3cret" roles="manager-gui" />

此外，还需要注释文件webapps/manager/META-INF/context.xml的以下内容，

  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1" />

否则 tomcat 会报以下错误，导致 tomcat 采集器无法采集到数据。

403 Access Denied
You are not authorized to view this page.

By default the Manager is only accessible from a browser running on the same machine as Tomcat. If you wish to modify this restriction, you'll need to edit the Manager's context.xml file.

Configuration

配置文件在 conf/input.tomcat/tomcat.toml

# # collect interval
# interval = 15

# Gather metrics from the Tomcat server status page.
[[instances]]
## URL of the Tomcat server status
url = "http://127.0.0.1:8080/manager/status/all?XML=true"

## HTTP Basic Auth Credentials
username = "tomcat"
password = "s3cret"

## Request timeout
# timeout = "5s"

# # interval = global.interval * interval_times
# interval_times = 1

# important! use global unique string to specify instance
# labels = { instance="192.168.1.2:8080", url="-" }

## Optional TLS Config
# use_tls = false
# tls_min_version = "1.2"
# tls_ca = "/etc/categraf/ca.pem"
# tls_cert = "/etc/categraf/cert.pem"
# tls_key = "/etc/categraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = true

监控大盘

本 README 文件的同级目录下放置了用于 Tomcat 的 dashboard.json，大家可以导入使用。

Documentation

Index

• type Instance
  • func (ins *Instance) Gather(slist *types.SampleList)
  • func (ins *Instance) Init() error
• type JvmMemoryPoolStat
• type JvmMemoryStat
• type RequestInfo
• type ThreadInfo
• type Tomcat
  • func (t *Tomcat) Clone() inputs.Input
  • func (t *Tomcat) GetInstances() []inputs.Instance
  • func (t *Tomcat) Name() string
• type TomcatConnector
• type TomcatJvm
• type TomcatStatus

Types

type Instance

type Instance struct {
	config.InstanceConfig

	URL      string          `toml:"url"`
	Username string          `toml:"username"`
	Password string          `toml:"password"`
	Timeout  config.Duration `toml:"timeout"`

	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*Instance) Gather

func (ins *Instance) Gather(slist *types.SampleList)

func (*Instance) Init

func (ins *Instance) Init() error

type JvmMemoryPoolStat

type JvmMemoryPoolStat struct {
	Name           string `xml:"name,attr"`
	Type           string `xml:"type,attr"`
	UsageInit      int64  `xml:"usageInit,attr"`
	UsageCommitted int64  `xml:"usageCommitted,attr"`
	UsageMax       int64  `xml:"usageMax,attr"`
	UsageUsed      int64  `xml:"usageUsed,attr"`
}

type JvmMemoryStat

type JvmMemoryStat struct {
	Free  int64 `xml:"free,attr"`
	Total int64 `xml:"total,attr"`
	Max   int64 `xml:"max,attr"`
}

type RequestInfo

type RequestInfo struct {
	MaxTime        int   `xml:"maxTime,attr"`
	ProcessingTime int   `xml:"processingTime,attr"`
	RequestCount   int   `xml:"requestCount,attr"`
	ErrorCount     int   `xml:"errorCount,attr"`
	BytesReceived  int64 `xml:"bytesReceived,attr"`
	BytesSent      int64 `xml:"bytesSent,attr"`
}

type ThreadInfo

type ThreadInfo struct {
	MaxThreads         int64 `xml:"maxThreads,attr"`
	CurrentThreadCount int64 `xml:"currentThreadCount,attr"`
	CurrentThreadsBusy int64 `xml:"currentThreadsBusy,attr"`
}

type Tomcat

type Tomcat struct {
	config.PluginConfig
	Instances []*Instance `toml:"instances"`
}

func (*Tomcat) Clone

func (t *Tomcat) Clone() inputs.Input

func (*Tomcat) GetInstances

func (t *Tomcat) GetInstances() []inputs.Instance

func (*Tomcat) Name

func (t *Tomcat) Name() string

type TomcatConnector

type TomcatConnector struct {
	Name        string      `xml:"name,attr"`
	ThreadInfo  ThreadInfo  `xml:"threadInfo"`
	RequestInfo RequestInfo `xml:"requestInfo"`
}

type TomcatJvm

type TomcatJvm struct {
	JvmMemory      JvmMemoryStat       `xml:"memory"`
	JvmMemoryPools []JvmMemoryPoolStat `xml:"memorypool"`
}

type TomcatStatus

type TomcatStatus struct {
	TomcatJvm        TomcatJvm         `xml:"jvm"`
	TomcatConnectors []TomcatConnector `xml:"connector"`
}