Apache Tomcat integration for Grafana Cloud

Before you begin

In order for the integration to properly work, you must set up the JMX Exporter for Prometheus to export metrics from Tomcat.

To enable JMX collection, make sure your Tomcat instance is configured with the following CATALINA_OPTS:

Copy

-Dcom.sun.management.jmxremote 
-Dcom.sun.management.jmxremote.port=9010 
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.ssl=false

Set up JMX Exporter

The JMX Exporter can be run with this Apache Tomcat JMX Exporter configuration file.

For more information on how to configure the JVM, please refer to the JMX Exporter documentation for further configuration.

Apache Tomcat exposes 9010 for JMX by default, but feel free to change the port to match your environment. The JMX URL for the exporter should be properly configured to match e.g. jmxUrl: service:jmx:rmi:///jndi/rmi://localhost:9010/jmxrmi

Once deployed, Grafana Alloy should be able to reach the JMX Exporter’s exposed endpoint in order to scrape metrics.

Install Apache Tomcat integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Apache Tomcat and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Apache Tomcat metrics and logs to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your Apache Tomcat setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single Apache Tomcat node running locally with default ports.

Manually copy and append the following snippets into your Grafana Alloy configuration file.

Metrics snippets

river Copy

discovery.relabel "metrics_integrations_tomcat" {
    targets = [{
        __address__ = "localhost:9010",
    }]

    rule {
        target_label = "instance"
        replacement  = constants.hostname
    }
}
prometheus.scrape "metrics_integrations_tomcat" {
    targets    = discovery.relabel.metrics_integrations_tomcat.output
    forward_to = [prometheus.remote_write.metrics_service.receiver]
    job_name   = "integrations/tomcat"
}

Logs snippets

darwin

river Copy

local.file_match "logs_integrations_tomcat_linux" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/{var,opt,usr/local}/{log,*tomcat*}/{*tomcat*,logs}/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_linux" {
    targets    = local.file_match.logs_integrations_tomcat_linux.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

linux

river Copy

local.file_match "logs_integrations_tomcat_linux" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/{var,opt,usr/local}/{log,*tomcat*}/{*tomcat*,logs}/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_linux" {
    targets    = local.file_match.logs_integrations_tomcat_linux.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

windows

river Copy

local.file_match "logs_integrations_tomcat_windows" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/Program Files/Apache Software Foundation/Tomcat *.*/logs/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_windows" {
    targets    = local.file_match.logs_integrations_tomcat_windows.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

Advanced mode

To instruct Grafana Alloy to scrape your Apache Tomcat nodes, go though the subsequent instructions.

The snippets provide examples to guide you through the configuration process.

First, manually copy and append the following snippets into your Grafana Alloy configuration file.

Then follow the instructions below to modify the necessary variables.

Advanced metrics snippets

river Copy

discovery.relabel "metrics_integrations_tomcat" {
    targets = [{
        __address__ = "localhost:9010",
    }]

    rule {
        target_label = "instance"
        replacement  = constants.hostname
    }
}
prometheus.scrape "metrics_integrations_tomcat" {
    targets    = discovery.relabel.metrics_integrations_tomcat.output
    forward_to = [prometheus.remote_write.metrics_service.receiver]
    job_name   = "integrations/tomcat"
}

After enabling the JMX exporter in your Apache Tomcat node, instruct Grafana Alloy to scrape it.

One discovery.relabel must be added for each Apache Tomcat node.

Configure the following properties within each discovery.relabel component:

• __address__: The address to the JMX exporter metrics endpoint.
• instance: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Apache Tomcat instance. Make sure this label value is the same for all telemetry data collected for this instance.

Finally, reference each discovery.relabel component within the targets property of the prometheus.scrape component.

Advanced logs snippets

darwin

river Copy

local.file_match "logs_integrations_tomcat_linux" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/{var,opt,usr/local}/{log,*tomcat*}/{*tomcat*,logs}/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_linux" {
    targets    = local.file_match.logs_integrations_tomcat_linux.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

To collect logs from unix-like systems, you need a pair of loki.source.file, and local.file_match components of Grafana Alloy.

The provided snippet is pre-configured with the default log write location for unix-like environments.

If you wish to capture other log files, you must add new maps to the path_targets list parameter of the local.file_match component, and include it in the targets list of loki.source.file component. Make sure that the new entry has the same instance and job labels, so it is matched to the correct instance to be shown in the Logs dashboard.

linux

river Copy

local.file_match "logs_integrations_tomcat_linux" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/{var,opt,usr/local}/{log,*tomcat*}/{*tomcat*,logs}/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_linux" {
    targets    = local.file_match.logs_integrations_tomcat_linux.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

To collect logs from unix-like systems, you need a pair of loki.source.file, and local.file_match components of Grafana Alloy.

The provided snippet is pre-configured with the default log write location for unix-like environments.

If you wish to capture other log files, you must add new maps to the path_targets list parameter of the local.file_match component, and include it in the targets list of loki.source.file component. Make sure that the new entry has the same instance and job labels, so it is matched to the correct instance to be shown in the Logs dashboard.

windows

river Copy

local.file_match "logs_integrations_tomcat_windows" {
    path_targets = [{
        __address__ = "localhost",
        __path__    = "/Program Files/Apache Software Foundation/Tomcat *.*/logs/catalina.out",
        instance    = constants.hostname,
        job         = "integrations/tomcat",
    }]
}
loki.source.file "logs_integrations_tomcat_windows" {
    targets    = local.file_match.logs_integrations_tomcat_windows.targets
    forward_to = [loki.write.grafana_cloud_loki.receiver]
}

To collect logs from Windows systems, you need a pair of loki.source.file, and local.file_match components of Grafana Alloy.

The provided snippet is pre-configured with the default log write location for Windows environments.

If you wish to capture other log files, you must add new maps to the path_targets list parameter of the local.file_match component, and include it in the targets list of loki.source.file component. Make sure that the new entry has the same instance and job labels, so it is matched to the correct instance to be shown in the Logs dashboard.

Before you begin

In order for the integration to properly work, you must set up the JMX Exporter for Prometheus to export metrics from Tomcat.

To enable JMX collection, make sure your Tomcat instance is configured with the following CATALINA_OPTS:

Copy

-Dcom.sun.management.jmxremote 
-Dcom.sun.management.jmxremote.port=9010 
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.ssl=false

Set up JMX Exporter

The JMX Exporter can be run with this Apache Tomcat JMX Exporter configuration file.

For more information on how to configure the JVM, please refer to the JMX Exporter documentation for further configuration.

Apache Tomcat exposes 9010 for JMX by default, but feel free to change the port to match your environment. The JMX URL for the exporter should be properly configured to match e.g. jmxUrl: service:jmx:rmi:///jndi/rmi://localhost:9010/jmxrmi

Once deployed, the Grafana Agent should be able to reach the JMX Exporter’s exposed endpoint in order to scrape metrics.

Install Apache Tomcat integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Apache Tomcat and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Apache Tomcat metrics and logs to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your Apache Tomcat setup.

Post-install configuration for the Apache Tomcat integration

After enabling the metrics generation, instruct the Grafana Agent to scrape your Apache Tomcat nodes.

Make sure to change targets in the snippet according to your environment.

If you want to show logs and metrics signals correlated in your dashboards as a single pane of glass, ensure the following:

• job and instance label values must match for the Apache Tomcat integration and logs scrape config in your agent configuration file.
• job label must be set to integrations/tomcat (already configured in the snippets)
• instance label must be set to a value that uniquely identifies your Apache Tomcat node. Please replace the default hostname value according to your environment - it should be set manually. Note that if you use localhost for multiple nodes, the dashboards will not be able to filter correctly by instance.

For the logs section, you may remove the job that does not correspond to your OS (e.g. remove the job with the /{var,opt}... path on Windows systems).

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml Copy

    - job_name: integrations/tomcat
      metrics_path: /metrics
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      static_configs: 
        - targets:
          - localhost:12345

Below logs.configs.scrape_configs, insert the following lines according to your environment.

yaml Copy

    - job_name: integrations/tomcat
      static_configs:
        - targets: [localhost] 
          labels:
            instance: '<your-instance-name>'
            __path__: /{var,opt}/{log,tomcat}/{tomcat*,logs}/catalina.out
    - job_name: integrations/tomcat
      static_configs:
        - targets: [localhost] 
          labels:
            instance: '<your-instance-name>'
            __path__: "/Program Files/Apache Software Foundation/Tomcat *.*/logs/catalina.out"

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Apache Tomcat integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml Copy

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/tomcat
      static_configs:
        - targets: [localhost] 
          labels:
            instance: '<your-instance-name>'
            __path__: /{var,opt}/{log,tomcat}/{tomcat*,logs}/catalina.out
    - job_name: integrations/tomcat
      static_configs:
        - targets: [localhost] 
          labels:
            instance: '<your-instance-name>'
            __path__: "/Program Files/Apache Software Foundation/Tomcat *.*/logs/catalina.out"
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/tomcat
      metrics_path: /metrics
      relabel_configs:
      - replacement: '<your-instance-name>'
        target_label: instance
      static_configs: 
        - targets:
          - localhost:12345
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal