Supported OS Linux Windows Mac OS

Integration version1.12.2
이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

Tomcat Dashboard


This check collects Tomcat metrics, for example:

  • Overall activity metrics: error count, request count, processing times, etc.
  • Thread pool metrics: thread count, number of threads busy, etc.
  • Servlet processing times



The Tomcat check is included in the Datadog Agent package, so you don’t need to install anything else on your Tomcat servers.

This check is JMX-based, so you need to enable JMX Remote on your Tomcat servers. Follow the instructions in Monitoring and Managing Tomcat .



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

  1. Edit the tomcat.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to collect Tomcat metrics and logs . See the sample tomcat.d/conf.yaml for all available configuration options.

  2. Restart the Agent .

See the JMX Check documentation for a list of configuration options usable by all JMX-based checks.

List of metrics

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

  • include (mandatory): A dictionary of filters. Any attribute that matches these filters is 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:


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.

      - include:
            alias: tomcat.threads.max
            metric_type: gauge
            alias: tomcat.threads.count
            metric_type: gauge
            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].

      - include:
        domain: org.apache.cassandra.db
          - 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
    - include:
      domain: domain_name
        - first_bean_name
        - second_bean_name
# Older Datadog Agent versions
    - include:
      domain: domain_name
      bean: first_bean_name
    - include:
      domain: domain_name
      bean: second_bean_name

Log collection

  1. To submit logs to Datadog, Tomcat uses the log4j logger. For versions of Tomcat before 8.0, log4j is configured by default. For Tomcat 8.0+, you must configure Tomcat to use log4j, see Using Log4j . In the first step of those instructions, edit the file in the $CATALINA_BASE/lib directory as follows:

      log4j.rootLogger = INFO, CATALINA
      # Define all the appenders
      log4j.appender.CATALINA = org.apache.log4j.DailyRollingFileAppender
      log4j.appender.CATALINA.File = /var/log/tomcat/catalina.log
      log4j.appender.CATALINA.Append = true
      # Roll-over the log once per day
      log4j.appender.CATALINA.layout = org.apache.log4j.PatternLayout
      log4j.appender.CATALINA.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n
      log4j.appender.LOCALHOST = org.apache.log4j.DailyRollingFileAppender
      log4j.appender.LOCALHOST.File = /var/log/tomcat/localhost.log
      log4j.appender.LOCALHOST.Append = true
      log4j.appender.LOCALHOST.layout = org.apache.log4j.PatternLayout
      log4j.appender.LOCALHOST.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n
      log4j.appender.MANAGER = org.apache.log4j.DailyRollingFileAppender
      log4j.appender.MANAGER.File = /var/log/tomcat/manager.log
      log4j.appender.MANAGER.Append = true
      log4j.appender.MANAGER.layout = org.apache.log4j.PatternLayout
      log4j.appender.MANAGER.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n
      log4j.appender.HOST-MANAGER = org.apache.log4j.DailyRollingFileAppender
      log4j.appender.HOST-MANAGER.File = /var/log/tomcat/host-manager.log
      log4j.appender.HOST-MANAGER.Append = true
      log4j.appender.HOST-MANAGER.layout = org.apache.log4j.PatternLayout
      log4j.appender.HOST-MANAGER.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n
      log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender
      log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout
      log4j.appender.CONSOLE.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %-5p [%t] %c{1}:%L - %m%n
      # Configure which loggers log to which appenders[Catalina].[localhost] = INFO, LOCALHOST[Catalina].[localhost].[/manager] =\
        INFO, MANAGER[Catalina].[localhost].[/host-manager] =\

    Then follow the remaining steps in the Tomcat docs for configuring log4j.

  2. By default, Datadog’s integration pipeline support the following conversion patterns:

      %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
      %d [%t] %-5p %c - %m%n

    Clone and edit the integration pipeline if you have a different format. See Logging in Tomcat for details on Tomcat logging capabilities.

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

    logs_enabled: true
  4. Add this configuration block to your tomcat.d/conf.yaml file to start collecting your Tomcat Logs:

      - type: file
        path: /var/log/tomcat/*.log
        source: tomcat
        service: "<SERVICE>"
        #To handle multi line that starts with yyyy-mm-dd use the following pattern
        #  - type: multi_line
        #    name: log_start_with_date
        #    pattern: \d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])

    Change the path and service parameter values and configure them for your environment. See the sample tomcat.yaml for all available configuration options.

  5. Restart the Agent .


For containerized environments, see the Autodiscovery with JMX guide.


Run the Agent’s status subcommand and look for tomcat under the Checks section.

Data Collected


The maximum number of allowed worker threads.
Shown as thread
The number of threads managed by the thread pool.
Shown as thread
The number of threads that are in use.
Shown as thread
Bytes per second sent by all the request processors.
Shown as byte
Bytes per second received by all request processors.
Shown as byte
The number of errors per second on all request processors.
Shown as error
The number of requests per second across all request processors.
Shown as request
The longest request processing time (in milliseconds).
Shown as millisecond
The sum of request processing times across all requests handled by the request processors (in milliseconds) per second.
The sum of request processing times across all requests to the servlet (in milliseconds) per second.
The number of erroneous requests received by the servlet per second.
Shown as error
The number of requests received by the servlet per second.
Shown as request
The number of accesses to the cache per second.
Shown as get
The number of cache hits per second.
Shown as hit
The number of accesses to the string cache per second.
Shown as get
The number of string cache hits per second.
Shown as hit
The number of lookups to the web resource cache per second.
Shown as get
The number of web resource cache hits per second.
Shown as hit
The number of JSPs per second that have been loaded in the web module.
Shown as page
The number of JSPs per second that have been reloaded in the web module.
Shown as page


The Tomcat check does not include any events.

Service Checks

Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored Tomcat instance, WARNING if no metrics are collected, and OK otherwise.
Statuses: ok, critical, warning


Missing tomcat.* metrics

The Datadog agent collects JMX metrics with either Catalina or Tomcat as bean domain names. Standalone Tomcat deployments have metrics under domain Catalina, but embedded Tomcat deployments (such as with Spring Boot) have metrics under domain Tomcat.

If the Datadog agent is older than 7.47.0, and if the exposed Tomcat metrics are prefixed with a different bean domain name, such as Tomcat, copy the default metrics from the metrics.yaml file to the conf section of the tomcat.d/conf.yaml file and modify the domain filter to use the applicable bean domain name.

- include:
    domain: Tomcat
    type: ThreadPool
        alias: tomcat.threads.max
        metric_type: gauge
        alias: tomcat.threads.count
        metric_type: gauge
        alias: tomcat.threads.busy
        metric_type: gauge

See the JMX Check documentation for more detailed information.

Commands to view the available metrics

The datadog-agent jmx command was added in version 4.1.0.

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

Further Reading

Additional helpful documentation, links, and articles: