Stackstate-Solr Integration

Overview

Get metrics from Solr in real time to

  • Visualize your search platform performance
  • Correlate the performance of Solr with the rest of your applications

Setup

Installation

Metrics will be captured using a JMX connection. This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page. You can specify the metrics you are interested in by editing the configuration below. To learn how to customize the metrics to collect visit the JMX Checks documentation for more detailed instructions. If you need to monitor more metrics, please send us an email at info@stackstate.com

Make sure that JMX Remote is enabled on your Tomcat server. For information on JMX , please see the JMX integration documentation.

Configuration

  1. Configure the Agent to connect to Tomcat. Edit conf.d/solr.yaml:

    instances:
      - host: localhost
        port: 9999
    # List of metrics to be collected by the integration
    # Read http://docs.stackstate.com/integrations/java/ to learn how to customize it
    init_config:
      conf:
        - include:
          type: searcher
          attribute:
            maxDoc:
              alias: solr.searcher.maxdoc
              metric_type: gauge
            numDocs:
              alias: solr.searcher.numdocs
              metric_type: gauge
            warmupTime:
              alias: solr.searcher.warmup
              metric_type: gauge
        - include:
          id: org.apache.solr.search.FastLRUCache
          attribute:
            cumulative_lookups:
              alias: solr.cache.lookups
              metric_type: counter
            cumulative_hits:
              alias: solr.cache.hits
              metric_type: counter
            cumulative_inserts:
              alias: solr.cache.inserts
              metric_type: counter
            cumulative_evictions:
              alias: solr.cache.evictions
              metric_type: counter
        - include:
          id: org.apache.solr.search.LRUCache
          attribute:
            cumulative_lookups:
              alias: solr.cache.lookups
              metric_type: counter
            cumulative_hits:
              alias: solr.cache.hits
              metric_type: counter
            cumulative_inserts:
              alias: solr.cache.inserts
              metric_type: counter
            cumulative_evictions:
              alias: solr.cache.evictions
              metric_type: counter
        - include:
          id: org.apache.solr.handler.component.SearchHandler
          attribute:
            errors:
              alias: solr.search_handler.errors
              metric_type: counter
            requests:
              alias: solr.search_handler.requests
              metric_type: counter
            timeouts:
              alias: solr.search_handler.timeouts
              metric_type: counter
            totalTime:
              alias: solr.search_handler.time
              metric_type: counter
            avgTimePerRequest:
              alias: solr.search_handler.avg_time_per_req
              metric_type: gauge
            avgRequestsPerSecond:
              alias: solr.search_handler.avg_requests_per_sec
              metric_type: gauge
    
  2. Restart the Agent

Configuration Options

  • user and password (Optional) - Username and password.
  • process_name_regex - (Optional) - Instead of specifying a host and port or jmx_url, the agent can connect using the attach api. This requires the JDK to be installed and the path to tools.jar to be set.
  • tools_jar_path - (Optional) - To be set when process_name_regex is set.
  • java_bin_path - (Optional) - Should be set if the agent cannot find your java executable.
  • java_options - (Optional) - Java JVM options
  • trust_store_path and trust_store_password - (Optional) - Should be set if ssl is enabled.

The conf parameter is a list of dictionaries. Only 2 keys are allowed in this dictionary:

  • include (mandatory): Dictionary of filters, any attribute that matches these filters will be collected unless it also matches the “exclude” filters (see below)
  • exclude (optional): Another dictionary of filters. Attributes that match these filters won’t be collected

For a given bean, metrics get tagged in the following manner:

mydomain:attr0=val0,attr1=val1

Your metric will be mydomain (or some variation depending on the attribute inside the bean) and have the tags attr0:val0, attr1:val1, domain:mydomain.

If you specify an alias in an include key that is formatted as camel case, it will be converted to snake case. For example, MyMetricName will be shown in Stackstate as my_metric_name.

The attribute filter

The attribute filter can accept two types of values:

  • A dictionary whose keys are attributes names:

    conf: - include: attribute: maxThreads: alias: tomcat.threads.max metric_type: gauge currentThreadCount: alias: tomcat.threads.count metric_type: gauge bytesReceived: alias: tomcat.bytes_rcvd metric_type: counter

In that case you can specify an alias for the metric that will become the metric name in Stackstate. You can also specify the metric type either a gauge or a counter. If you choose counter, a rate per second will be computed for this metric.

  • A list of attributes names:

    conf: - include: domain: org.apache.cassandra.db attribute: - BloomFilterDiskSpaceUsed - BloomFilterFalsePositives - BloomFilterFalseRatio - Capacity - CompressionRatio - CompletedTasks - ExceptionCount - Hits - RecentHitRate

In that case:

  • The metric type will be a gauge
  • The metric name will be jmx.[DOMAIN_NAME].[ATTRIBUTE_NAME]

Here is another filtering example:

instances:
  - host: 127.0.0.1
    name: jmx_instance
    port: 9999

init_config:
  conf:
    - include:
      bean: org.apache.cassandra.metrics:type=ClientRequest,scope=Write,name=Latency
      attribute:
        - OneMinuteRate
        - 75thPercentile
        - 95thPercentile
        - 99thPercentile

Note

conf:
  - include:
    domain: domain_name
    bean:
      - first_bean_name
      - second_bean_name

Validation

Execute the info command and verify that the integration check has passed. The output of the command should contain a section similar to the following:

Checks
======

  [...]

  solr
  ----
      - instance #0 [OK]
      - Collected 13 metrics & 0 events

Data Collected

Metrics

solr.searcher.maxdoc
(gauge)
One greater than the largest possible document number.
shown as document
solr.searcher.numdocs
(gauge)
The total number of indexed documents.
shown as document
solr.searcher.warmup
(gauge)
The time spent warming up.
shown as millisecond
solr.cache.hits
(gauge)
The number of cache hits per second.
shown as hit
solr.cache.lookups
(gauge)
The total number of cache lookups per second.
shown as get
solr.cache.inserts
(gauge)
The total number of cache inserts per second.
shown as set
solr.cache.evictions
(gauge)
The total number of cache evictions per second.
shown as eviction
solr.search_handler.errors
(gauge)
Number of errors per second encountered by the handler.
shown as error
solr.search_handler.requests
(gauge)
Number of requests per second processed by the handler.
shown as request
solr.search_handler.timeouts
(gauge)
Number of responses per second received with partial results.
shown as timeout
solr.search_handler.time
(gauge)
The sum of all request processing times (in milliseconds) per second.
shown as
solr.search_handler.avg_time_per_req
(gauge)
The average time per request.
shown as millisecond
solr.search_handler.avg_requests_per_sec
(gauge)
The average number of requests per second.
shown as request

Troubleshooting

Commands to view the metrics that are available:

  • List attributes that match at least one of your instances configuration: sudo /etc/init.d/stackstate-agent jmx list_matching_attributes
  • List attributes that do match one of your instances configuration but that are not being collected because it would exceed the number of metrics that can be collected: sudo /etc/init.d/stackstate-agent jmx list_limited_attributes
  • List attributes that will actually be collected by your current instances configuration: sudo /etc/init.d/stackstate-agent jmx list_collected_attributes
  • List attributes that don’t match any of your instances configuration: sudo /etc/init.d/stackstate-agent jmx list_not_matching_attributes
  • List every attributes available that has a type supported by JMXFetch: sudo /etc/init.d/stackstate-agent jmx list_everything
  • Start the collection of metrics based on your current configuration and display them in the console: sudo /etc/init.d/stackstate-agent jmx collect