Host

To configure this check for an Agent running on a host:

1. Edit the solr.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample solr.d/conf.yaml for all available configuration options.

   init_config:
   
     ## @param is_jmx - boolean - required
     ## Whether or not this file is a configuration for a JMX integration.
     #
     is_jmx: true
   
     ## @param collect_default_metrics - boolean - required
     ## Whether or not the check should collect all default metrics.
     #
     collect_default_metrics: true
   
   instances:
     ## @param host - string - required
     ## Solr host to connect to.
     - host: localhost
   
       ## @param port - integer - required
       ## Solr port to connect to.
       port: 9999
   

2. Restart the Agent.

List of metrics

The conf parameter is a list of metrics to be collected by the integration. Only 2 keys are allowed:

• include (mandatory): A dictionary of filters, any attribute that matches these filters are collected unless it also matches the exclude filters (see below).
• exclude (optional): A dictionary of filters, attributes that match these filters are not collected.

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

mydomain:attr0=val0,attr1=val1

In this example, your metric is mydomain (or some variation depending on the attribute inside the bean) and has the tags attr0:val0, attr1:val1, and domain:mydomain.

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

The attribute filter

The attribute filter can accept two types of values:

• A dictionary whose keys are attributes names (see below). For this case, you can specify an alias for the metric that becomes the metric name in Datadog. You can also specify the metric type as a gauge or counter. If you choose counter, a rate per second is computed for the metric.

  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
  

• A list of attributes names (see below). For this case, the metric type is a gauge, and the metric name is jmx.\[DOMAIN_NAME].\[ATTRIBUTE_NAME].

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

Older versions

List of filters is only supported in Datadog Agent > 5.3.0. If you are using an older version, use singletons and multiple include statements instead.

# Datadog Agent > 5.3.0
  conf:
    - include:
      domain: domain_name
      bean:
        - first_bean_name
        - second_bean_name
# Older Datadog Agent versions
  conf:
    - include:
      domain: domain_name
      bean: first_bean_name
    - include:
      domain: domain_name
      bean: second_bean_name

Containerized

For containerized environments, see the Autodiscovery with JMX guide.

Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

    logs_enabled: true
   

2. Solr uses the log4j logger by default. To customize the logging format, edit the server/resources/log4j2.xml file. By default, Datadog’s integration pipeline supports the following conversion pattern:

   %maxLen{%d{yyyy-MM-dd HH:mm:ss.SSS} %-5p (%t) [%X{collection} %X{shard} %X{replica} %X{core}] %c{1.} %m%notEmpty{ =>%ex{short}}}{10240}%n
   

   Clone and edit the integration pipeline if you have a different format.

3. Uncomment and edit the logs configuration block in your solr.d/conf.yaml file. Change the type, path, and service parameter values based on your environment. See the sample solr.d/solr.yaml for all available configuration options.

    logs:
      - type: file
        path: /var/solr/logs/solr.log
        source: solr
        # To handle multi line that starts with yyyy-mm-dd use the following pattern
        # log_processing_rules:
        #   - type: multi_line
        #     pattern: \d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])
        #     name: new_log_start_with_date
   

4. Restart the Agent.

To enable logs for Kubernetes environments, see Kubernetes Log Collection.