solr

README

Solr monitoring with Netdata

Solr is an open-source enterprise-search platform, written in Java, from the Apache Lucene project.

This module monitors Solr request handler statistics.

Requirement

• Solr version 6.4+

Metrics

All metrics have "solr." prefix.

Metric	Scope	Dimensions	Units
search_requests	global	search	requests/s
search_errors	global	errors	errors/s
search_errors_by_type	global	client, server, timeouts	errors/s
search_requests_processing_time	global	time	milliseconds
search_requests_timings	global	min, median, mean, max	milliseconds
search_requests_processing_time_percentile	global	p75, p95, p99, p999	milliseconds
update_requests	global	search	requests/s
update_errors	global	errors	errors/s
update_errors_by_type	global	client, server, timeouts	errors/s
update_requests_processing_time	global	time	milliseconds
update_requests_timings	global	min, median, mean, max	milliseconds
update_requests_processing_time_percentile	global	p75, p95, p99, p999	milliseconds

Configuration

Edit the go.d/solr.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/solr.conf

Here is an example for 2 servers:

jobs:
  - name: local
    url: http://localhost:8983

  - name: remote
    url: http://203.0.113.10:8983

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the solr collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m solr
  

Documentation

Index

• type Charts
• type Config
• type Dims
• type Solr
  • func New() *Solr
  • func (s *Solr) Charts() *Charts
  • func (s *Solr) Check() bool
  • func (Solr) Cleanup()
  • func (s *Solr) Collect() map[string]int64
  • func (s *Solr) Init() bool

Types

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Config

type Config struct {
	web.HTTP `yaml:",inline"`
}

Config is the Solr module configuration.

type Dims

type Dims = module.Dims

Dims is an alias for module.Dims

type Solr

type Solr struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

Solr solr module

func New

func New() *Solr

New creates Solr with default values

func (*Solr) Charts

func (s *Solr) Charts() *Charts

Charts creates Charts

func (*Solr) Check

func (s *Solr) Check() bool

Check makes check

func (Solr) Cleanup

func (Solr) Cleanup()

Cleanup makes cleanup

func (*Solr) Collect

func (s *Solr) Collect() map[string]int64

Collect collects metrics

func (*Solr) Init

func (s *Solr) Init() bool

Init makes initialization