Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
269 lines (134 sloc) 12.5 KB

Solr Metrics API

Retrieving all Metrics

Get all metrics:

localhost:8983/solr/admin/metrics

Retrieving Metrics for Specific Group

Metrics for a group (groups: solr.jvm, solr.node, solr.jetty, solr.core.<collection_name>):

localhost:8983/solr/admin/metrics?group=solr.jvm

Retrieving Metrics in JSON

Default is XML. For JSON:

localhost:8983/solr/admin/metrics?wt=json

localhost:8983/solr/admin/metrics?wt=json&indent=true

Jetty Metrics

Number of Requests with Given Response Status

Check the number of requests with the given HTTP status, useful when checking for number of errors and successful requests:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.1xx

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.2xx

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.3xx

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.4xx

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.5xx

Aggregated Error Percentage

Retrieve aggregated error percentage for 1, 5 and 15 minutes periods:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-4xx-1m

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-4xx-5m

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-4xx-15m

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-5xx-1m

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-5xx-5m

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.percent-5xx-15m

HTTP Requests Related Statistics

Statistics for all requests sent to Solr:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.requests

HTTP Method Divided Statistics

Statistics for a given HTTP method:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.post-requests

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.put-requests

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.get-requests

Active Requests Statistics

Information on current requests:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.active

Asynchronous Requests Statistics

Asynchronous request being processed:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.async

Thread Pools Utilization

Jetty thread pools utilization, useful for finding thread settings issues:

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.util.thread.QueuedThreadPool

JVM Metrics

Direct Buffers Information

Direct buffer used by Solr that are mapped via heap memory:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=buffers.direct

Mapped Buffers Information

Memory mapped buffers used by Solr and shared with operating system cache:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=buffers.mapped

Garbage Collection Information

Garbage collection information:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=gc

JVM Heap Statistics

Heap usage information:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=memory.heap

Out Of Heap Memory Usage

Out of heap memory usage by Solr:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=memory.non-heap

Memory Pools Information

Memory pools utilization:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=memory.pools

Total Memory Used

Total memory usage of the system running Solr:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=memory.total

Operating System Information

Operating system information (CPU count, file descriptors, swap, memory usage, load):

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=os

Threads Related Statistics

Threads information to help checking blocked ones:

localhost:8983/solr/admin/metrics?group=solr.jvm&prefix=threads

Solr Node Metrics

Authorization Errors

Authorization errors:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=ADMIN./admin/authorization.errors

Collections API Usage Statistics

Collections API usage statistics:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=ADMIN./admin/collections

ZooKeeper Communication Statistics

ZooKeeper communication statistics useful in diagnosing problems with connectivity:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=ADMIN./admin/zookeeper

Loaded, Unloaded & Lazy Loaded Cores

Information on deployed cores, working ones and lazily loaded ones:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=CONTAINER.cores

Shard Handler Statistics

Information about shard handler, useful in diagnosing between shards communication problems:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=QUERY.httpShardHandler

Update Shard Handler Information

Update shard handler statistics to diagnose update messages transferred between shards:

localhost:8983/solr/admin/metrics?group=solr.node&prefix=UPDATE.updateShardHandler

Core Or Collection Metrics

Update Handler Related Metrics

Indexing related performance information:

localhost:8983/solr/admin/metrics?prefix=UPDATE./update

Transaction Log Metrics

Transaction log can be a source of problems if it too large, check it with:

localhost:8983/solr/admin/metrics?prefix=TLOG

Replication Statistics

localhost:8983/solr/admin/metrics?prefix=REPLICATION

Searcher Warmup And Creation Time Information

localhost:8983/solr/admin/metrics?prefix=SEARCHER

Default /select Handler Query Related Statistics

We can retrieve statistics about any handler, just like the default /select handler:

localhost:8983/solr/admin/metrics?prefix=QUERY./select

Merges Related Information

Merging can be expensive or slow, check its performance with:

localhost:8983/solr/admin/metrics?prefix=INDEX.merge

General Reads And Writes Information

All I/O operations in Solr are done via the Directory interface, check its usage with:

localhost:8983/solr/admin/metrics?prefix=DIRECTORY

Troubleshooting

Checking Solr memory usage

localhost:8983/solr/admin/metrics?prefix=memory.&wt=json&indent=true

Garbage collection issues

localhost:8983/solr/admin/metrics?prefix=gc.&wt=json&indent=true

localhost:8983/solr/admin/metrics?prefix=memory.pools.&wt=json&indent=true

_I/O issues _

localhost:8983/solr/admin/metrics?prefix=DIRECTORY.&wt=json&indent=true

localhost:8983/solr/admin/metrics?prefix=INDEX.merge.&wt=json&indent=true

localhost:8983/solr/admin/metrics?prefix=INDEX.&wt=json&indent=true

_Retrieving transaction log information _

localhost:8983/solr/admin/metrics?prefix=TLOG.&wt=json&indent=true

Checking direct and mapped memory size

localhost:8983/solr/admin/metrics?prefix=buffers.&wt=json&indent=true

Checking number of errors

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.4xx-responses&wt=json&indent=true

localhost:8983/solr/admin/metrics?prefix=org.eclipse.jetty.server.handler.DefaultHandler.5xx-responses&wt=json&indent=true

Checking replication metrics

localhost:8983/solr/admin/metrics?prefix=REPLICATION.&wt=json&indent=true

Retrieving searchers warm-up times

localhost:8983/solr/admin/metrics?prefix=SEARCHER.&wt=json&indent=true

Threads related statistics

localhost:8983/solr/admin/metrics?prefix=threads.&wt=json&indent=true