You are viewing docs on Elastic's new documentation system, currently in technical preview. For all other Elastic docs, visit elastic.co/guide.

Spring Boot

This Elastic integration collects logs and metrics from Spring Boot integration.

Version
1.3.1 (View all)
Compatible Kibana version(s)
8.9.0 or higher
Supported Serverless project types

Security
Observability
Subscription level
Basic
Level of support
Elastic

Overview

The Spring Boot integration is used to fetch observability data from Spring Boot Actuator web endpoints and ingest it into Elasticsearch.

Use the Spring Boot integration to:

  • Collect logs related to audit events, HTTP trace, and metrics related to garbage collection(gc), memory, and threading.
  • Create visualizations to monitor, measure, and analyze usage trends and key data, deriving business insights.
  • Create alerts to reduce the MTTD and MTTR by referencing relevant logs when troubleshooting an issue.

Data streams

The Spring Boot integration collects logs and metrics data.

Logs help you keep a record of events that occur on your machine. The Log data streams collected by Spring Boot integration are auditevents and httptrace, allowing users to track authentication events, HTTP request and response details, enabling comprehensive monitoring and security auditing.

Metrics provide insight into the statistics of Spring Boot. The Metrics data streams collected by the Spring Boot integration include auditevents, gc, httptrace, memory, and threading, enabling users to monitor and troubleshoot the performance of Spring Boot instances.

Data streams:

  • auditevents: Collects information related to the authentication status, remote address, document ID and principal.
  • gc: Collects information related to the GC collector name, memory usage before and after collection, thread count, and time metrics.
  • httptrace: Collects information related to the http requests, status response, principal and session details.
  • memory: Collects information related to the heap and non-heap memory, buffer pool and manager.
  • threading: Collects information related to the thread allocations, monitoring and CPU times.

Note:

  • Users can monitor and view the logs inside the ingested documents for Spring Boot in the logs-* index pattern from Discover, while for metrics, the index pattern is metrics-*.

Compatibility

This integration has been tested against Spring Boot v2.7.17 with LTS JDK versions 8, 11, 17, and 21.

Requirements

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended or self-manage the Elastic Stack on your own hardware.

In order to ingest data from Spring Boot:

  • You must know the host for Spring Boot application, add that host while configuring the integration package.
  • Add default path for jolokia.
  • Spring-boot-actuator module provides all Spring Boot's production-ready features. You also need to add the following dependency to the pom.xml file:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
  • For access of jolokia add below dependency in pom.xml of Spring Boot Application.
<dependency>
    <groupId>org.jolokia</groupId>
    <artifactId>jolokia-core</artifactId>
</dependency>

Setup

For step-by-step instructions on how to set up an integration, see the Getting Started guide.

Validation

After the integration is successfully configured, click on the Assets tab of the Spring Boot Integration to display the available dashboards. Select the dashboard for your configured data stream, which should be populated with the required data.

Troubleshooting

  • If [Spring Boot] Audit Events panel does not display older documents after upgrading to 0.9.0 or later versions, this issue can be resolved by reindexing the Audit Events data stream.
  • If host.ip appears conflicted under the logs-* data view, this issue can be resolved by reindexing the Audit Events data stream.
  • If host.ip appears conflicted under the metrics-* data view, this issue can be resolved by reindexing the Garbage Collector, Memory and Threading data stream.

Logs

Audit Events logs

This is the audit_events data stream.

  • This data stream exposes audit events information for the current application.

An example event for audit_events looks as following:

{
    "@timestamp": "2022-08-05T09:30:10.644Z",
    "agent": {
        "ephemeral_id": "575ffec5-bd74-4689-8baa-8486735193f3",
        "id": "3ab22ca1-4caf-465f-8789-2a45a81ed9b1",
        "name": "docker-fleet-agent",
        "type": "filebeat",
        "version": "8.1.0"
    },
    "data_stream": {
        "dataset": "spring_boot.audit_events",
        "namespace": "ep",
        "type": "logs"
    },
    "ecs": {
        "version": "8.5.1"
    },
    "elastic_agent": {
        "id": "3ab22ca1-4caf-465f-8789-2a45a81ed9b1",
        "snapshot": false,
        "version": "8.1.0"
    },
    "event": {
        "agent_id_status": "verified",
        "category": "web",
        "created": "2022-08-05T09:30:10.644Z",
        "dataset": "spring_boot.audit_events",
        "ingested": "2022-08-05T09:30:14Z",
        "kind": "event",
        "module": "spring_boot",
        "type": [
            "info"
        ]
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "ip": [
            "192.168.112.5"
        ],
        "mac": [
            "02:42:c0:a8:70:05"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.71.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.4 LTS (Focal Fossa)"
        }
    },
    "spring_boot": {
        "audit_events": {
            "data": {
                "remote_address": "192.168.144.2"
            },
            "document_id": "Es32QTyIFsbGsH5nlZQxBDYnf18=",
            "principal": "actuator",
            "type": "AUTHENTICATION_SUCCESS"
        }
    },
    "tags": [
        "spring_boot.audit_events.metrics"
    ]
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
event.dataset
Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.
keyword
event.kind
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.
keyword
event.module
Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module.
keyword
event.type
This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types.
keyword
host.ip
Host ip addresses.
ip
spring_boot.audit_events.data.remote_address
Remote Address of the Spring Boot application user.
keyword
spring_boot.audit_events.data.session_id
Session ID of the Spring Boot application user.
keyword
spring_boot.audit_events.document_id
Unique document id generated by Elasticsearch.
keyword
spring_boot.audit_events.principal
Restricts the events to those with the given principal.
keyword
spring_boot.audit_events.type
Authentication type.
keyword
tags
List of keywords used to tag each event.
keyword

HTTP Trace logs

This is the http_trace data stream.

  • This data stream displays HTTP trace information.

An example event for http_trace looks as following:

{
    "@timestamp": "2022-08-05T09:31:44.895Z",
    "agent": {
        "ephemeral_id": "d55155ad-e1c4-4c29-a809-1d8b7b539e39",
        "id": "3ab22ca1-4caf-465f-8789-2a45a81ed9b1",
        "name": "docker-fleet-agent",
        "type": "filebeat",
        "version": "8.1.0"
    },
    "data_stream": {
        "dataset": "spring_boot.http_trace",
        "namespace": "ep",
        "type": "logs"
    },
    "ecs": {
        "version": "8.5.1"
    },
    "elastic_agent": {
        "id": "3ab22ca1-4caf-465f-8789-2a45a81ed9b1",
        "snapshot": false,
        "version": "8.1.0"
    },
    "event": {
        "agent_id_status": "verified",
        "category": "web",
        "created": "2022-08-05T09:31:44.895Z",
        "dataset": "spring_boot.http_trace",
        "duration": 2,
        "ingested": "2022-08-05T09:31:48Z",
        "kind": "event",
        "module": "spring_boot",
        "type": [
            "info"
        ]
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "ip": [
            "192.168.112.5"
        ],
        "mac": [
            "02:42:c0:a8:70:05"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.71.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.4 LTS (Focal Fossa)"
        }
    },
    "http": {
        "request": {
            "method": "GET",
            "referrer": "http://springboot:8090/actuator/info"
        },
        "response": {
            "status_code": 200
        }
    },
    "tags": [
        "spring_boot.http_trace.metrics"
    ]
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
event.dataset
Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.
keyword
event.duration
Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time.
long
event.kind
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.
keyword
event.module
Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module.
keyword
event.type
This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types.
keyword
host.ip
Host ip addresses.
ip
http.request.method
HTTP request method. The value should retain its casing from the original event. For example, GET, get, and GeT are all considered valid values for this field.
keyword
http.request.referrer
Referrer for this HTTP request.
keyword
http.response.status_code
HTTP response status code.
long
spring_boot.http_trace.principal
Principal of the exchange.
keyword
spring_boot.http_trace.session
Session associated with the exchange.
keyword
tags
List of keywords used to tag each event.
keyword

Metrics

Memory Metrics

This is the memory data stream.

  • This data stream gives metrics related to heap and non-heap memory, buffer pool and manager.

An example event for memory looks as following:

{
    "@timestamp": "2023-09-28T13:08:46.636Z",
    "agent": {
        "ephemeral_id": "f6ab2af3-153b-4970-99c9-a9c564407b18",
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "name": "docker-fleet-agent",
        "type": "metricbeat",
        "version": "8.5.1"
    },
    "data_stream": {
        "dataset": "spring_boot.memory",
        "namespace": "ep",
        "type": "metrics"
    },
    "ecs": {
        "version": "8.5.1"
    },
    "elastic_agent": {
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "snapshot": false,
        "version": "8.5.1"
    },
    "event": {
        "agent_id_status": "verified",
        "category": [
            "web"
        ],
        "dataset": "spring_boot.memory",
        "duration": 566740708,
        "ingested": "2023-09-28T13:08:48Z",
        "kind": "metric",
        "module": "spring_boot",
        "type": "info"
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "id": "75e38940166b4dbc90b6f5610e8e9c39",
        "ip": [
            "192.168.246.7"
        ],
        "mac": [
            "02-42-C0-A8-F6-07"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.90.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.5 LTS (Focal Fossa)"
        }
    },
    "metricset": {
        "name": "jmx",
        "period": 60000
    },
    "service": {
        "address": "http://springboot:8090/actuator/jolokia",
        "type": "jolokia"
    },
    "spring_boot": {
        "memory": {
            "heap": {
                "committed": 579338240,
                "init": 260046848,
                "max": 3698851840,
                "used": 172880800
            },
            "non_heap": {
                "committed": 62873600,
                "init": 2555904,
                "max": -1,
                "used": 56856368
            }
        }
    },
    "tags": [
        "spring_boot.memory.metrics"
    ]
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
error.message
Error message.
match_only_text
event.category
This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories.
keyword
event.dataset
Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.
keyword
event.kind
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.
keyword
event.module
Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module.
keyword
host.ip
Host ip addresses.
ip
service.address
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).
keyword
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword
spring_boot.memory.buffer_pool.direct.count
Count of direct buffer pool memory.
long
spring_boot.memory.buffer_pool.direct.total_capacity
Total capacity of direct buffer pool memory.
long
spring_boot.memory.buffer_pool.direct.used
Used memory of direct buffer pool.
long
spring_boot.memory.buffer_pool.mapped.count
Count of mapped buffer pool memory.
long
spring_boot.memory.buffer_pool.mapped.total_capacity
Total capacity of mapped buffer pool memory.
long
spring_boot.memory.buffer_pool.mapped.used
Used memory of mapped buffer pool.
long
spring_boot.memory.heap.committed
Committed heap memory usage of JVM.
long
spring_boot.memory.heap.init
Init heap memory usage of JVM.
long
spring_boot.memory.heap.max
Max heap memory usage of JVM.
long
spring_boot.memory.heap.used
Used heap memory usage of JVM.
long
spring_boot.memory.manager.code_cache.name
Name of the cacheManager to qualify the cache.
keyword
spring_boot.memory.manager.code_cache.valid
Validation of code cache.
boolean
spring_boot.memory.manager.metaspace.name
Name of the Metaspace Manager to qualify the cache.
keyword
spring_boot.memory.manager.metaspace.valid
Validation of metaspace manager.
boolean
spring_boot.memory.non_heap.committed
Committed non-heap memory usage of JVM.
long
spring_boot.memory.non_heap.init
Init non-heap memory usage of JVM.
long
spring_boot.memory.non_heap.max
Max non-heap memory usage of JVM.
long
spring_boot.memory.non_heap.used
Used non-heap memory usage of JVM.
long
tags
List of keywords used to tag each event.
keyword

Threading Metrics

This is the threading data stream.

  • This data stream gives metrics related to thread allocations, monitoring and CPU times.

An example event for threading looks as following:

{
    "@timestamp": "2023-09-28T13:09:36.850Z",
    "agent": {
        "ephemeral_id": "f6ab2af3-153b-4970-99c9-a9c564407b18",
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "name": "docker-fleet-agent",
        "type": "metricbeat",
        "version": "8.5.1"
    },
    "data_stream": {
        "dataset": "spring_boot.threading",
        "namespace": "ep",
        "type": "metrics"
    },
    "ecs": {
        "version": "8.5.1"
    },
    "elastic_agent": {
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "snapshot": false,
        "version": "8.5.1"
    },
    "event": {
        "agent_id_status": "verified",
        "category": [
            "web"
        ],
        "dataset": "spring_boot.threading",
        "duration": 197157690,
        "ingested": "2023-09-28T13:09:38Z",
        "kind": "metric",
        "module": "spring_boot",
        "type": "info"
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "id": "75e38940166b4dbc90b6f5610e8e9c39",
        "ip": [
            "192.168.246.7"
        ],
        "mac": [
            "02-42-C0-A8-F6-07"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.90.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.5 LTS (Focal Fossa)"
        }
    },
    "metricset": {
        "name": "jmx",
        "period": 60000
    },
    "service": {
        "address": "http://springboot:8090/actuator/jolokia",
        "type": "jolokia"
    },
    "spring_boot": {
        "threading": {
            "threads": {
                "count": 20,
                "current": {
                    "allocated_bytes": 28523936,
                    "time": {
                        "cpu": 380757629,
                        "user": 370000000
                    }
                },
                "daemon": 16,
                "started": 23
            }
        }
    },
    "tags": [
        "spring_boot.threading.metrics"
    ]
}

Exported fields

FieldDescriptionType
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
error.message
Error message.
match_only_text
event.category
This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories.
keyword
event.dataset
Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.
keyword
event.kind
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.
keyword
event.module
Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module.
keyword
host.ip
Host ip addresses.
ip
service.address
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).
keyword
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword
spring_boot.threading.threads.count
Current number of live threads including both daemon and non-daemon threads.
long
spring_boot.threading.threads.current.allocated_bytes
Allocated bytes for the current thread.
double
spring_boot.threading.threads.current.time.cpu
CPU time for the current thread in nanoseconds.
long
spring_boot.threading.threads.current.time.user
User time for the current thread.
long
spring_boot.threading.threads.daemon
Current number of live daemon threads.
long
spring_boot.threading.threads.started
Total number of threads created and also started since the Java virtual machine started.
long
tags
List of keywords used to tag each event.
keyword

GC Metrics

This is the gc data stream.

  • This data stream gives metrics related to Garbage Collector (GC) Memory.

An example event for gc looks as following:

{
    "@timestamp": "2023-09-28T13:07:07.602Z",
    "agent": {
        "ephemeral_id": "dcb46246-ff32-4d0e-89ce-d72ce374bb33",
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "name": "docker-fleet-agent",
        "type": "metricbeat",
        "version": "8.5.1"
    },
    "data_stream": {
        "dataset": "spring_boot.gc",
        "namespace": "ep",
        "type": "metrics"
    },
    "ecs": {
        "version": "8.5.1"
    },
    "elastic_agent": {
        "id": "9a3f2233-d554-4847-9b74-1465e769563d",
        "snapshot": false,
        "version": "8.5.1"
    },
    "event": {
        "agent_id_status": "verified",
        "category": [
            "web"
        ],
        "dataset": "spring_boot.gc",
        "duration": 221408484,
        "ingested": "2023-09-28T13:07:08Z",
        "kind": "metric",
        "module": "spring_boot",
        "type": [
            "info"
        ]
    },
    "host": {
        "architecture": "x86_64",
        "containerized": true,
        "hostname": "docker-fleet-agent",
        "id": "75e38940166b4dbc90b6f5610e8e9c39",
        "ip": [
            "192.168.246.7"
        ],
        "mac": [
            "02-42-C0-A8-F6-07"
        ],
        "name": "docker-fleet-agent",
        "os": {
            "codename": "focal",
            "family": "debian",
            "kernel": "3.10.0-1160.90.1.el7.x86_64",
            "name": "Ubuntu",
            "platform": "ubuntu",
            "type": "linux",
            "version": "20.04.5 LTS (Focal Fossa)"
        }
    },
    "metricset": {
        "name": "jmx",
        "period": 60000
    },
    "service": {
        "address": "http://springboot:8090/actuator/jolokia",
        "type": "jolokia"
    },
    "spring_boot": {
        "gc": {
            "last_info": {
                "id": 2,
                "memory_usage": {
                    "after": {
                        "code_cache": {
                            "committed": 14286848,
                            "init": 2555904,
                            "max": 251658240,
                            "used": 14209088
                        },
                        "compressed_class_space": {
                            "committed": 4980736,
                            "init": 0,
                            "max": 1073741824,
                            "used": 4436328
                        },
                        "metaspace": {
                            "committed": 36265984,
                            "init": 0,
                            "max": -1,
                            "used": 33758840
                        },
                        "ps_eden_space": {
                            "committed": 435683328,
                            "init": 65536000,
                            "max": 1354760192,
                            "used": 0
                        },
                        "ps_old_gen": {
                            "committed": 118489088,
                            "init": 173539328,
                            "max": 2774007808,
                            "used": 14683728
                        },
                        "ps_survivor_space": {
                            "committed": 16777216,
                            "init": 10485760,
                            "max": 16777216,
                            "used": 0
                        }
                    },
                    "before": {
                        "code_cache": {
                            "committed": 14286848,
                            "init": 2555904,
                            "max": 251658240,
                            "used": 14209088
                        },
                        "compressed_class_space": {
                            "committed": 4980736,
                            "init": 0,
                            "max": 1073741824,
                            "used": 4436328
                        },
                        "metaspace": {
                            "committed": 36265984,
                            "init": 0,
                            "max": -1,
                            "used": 33758840
                        },
                        "ps_eden_space": {
                            "committed": 435683328,
                            "init": 65536000,
                            "max": 1354760192,
                            "used": 0
                        },
                        "ps_old_gen": {
                            "committed": 94896128,
                            "init": 173539328,
                            "max": 2774007808,
                            "used": 10795056
                        },
                        "ps_survivor_space": {
                            "committed": 16777216,
                            "init": 10485760,
                            "max": 16777216,
                            "used": 8519744
                        }
                    }
                },
                "thread_count": 10,
                "time": {
                    "duration": 40,
                    "end": 3588,
                    "start": 3548
                }
            },
            "name": "PS MarkSweep"
        }
    },
    "tags": [
        "spring_boot.gc.metrics"
    ]
}

Exported fields

FieldDescriptionTypeUnit
@timestamp
Event timestamp.
date
data_stream.dataset
Data stream dataset.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
error.message
Error message.
match_only_text
event.category
This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. event.category represents the "big buckets" of ECS categories. For example, filtering on event.category:process yields all events relating to process activity. This field is closely related to event.type, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories.
keyword
event.dataset
Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name.
keyword
event.duration
Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time.
long
event.ingested
Timestamp when an event arrived in the central data store. This is different from @timestamp, which is when the event originally occurred. It's also different from event.created, which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: @timestamp < event.created < event.ingested.
date
event.kind
This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. event.kind gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.
keyword
event.module
Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), event.module should contain the name of this module.
keyword
event.type
This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. event.type represents a categorization "sub-bucket" that, when used along with the event.category field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types.
keyword
host.ip
Host ip addresses.
ip
service.address
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets).
keyword
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword
spring_boot.gc.last_info.id
ID of the GC.
long
spring_boot.gc.last_info.memory_usage.after.code_cache.committed
Committed memory of the code cache memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.code_cache.init
Init memory of the code cache memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.code_cache.max
Max memory of the code cache memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.code_cache.used
Used memory of the code cache memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.compressed_class_space.committed
Committed memory of the compressed class space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.compressed_class_space.init
Init memory of the compressed class space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.compressed_class_space.max
Max memory of the compressed class space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.compressed_class_space.used
Used memory of the compressed class space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_eden_space.committed
Committed memory of the G1 Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_eden_space.init
Init memory of the G1 Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_eden_space.max
Max memory of the G1 Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_eden_space.used
Used memory of the G1 Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_old_gen.committed
Committed memory of the G1 Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_old_gen.init
Init memory of the G1 Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_old_gen.max
Max memory of the G1 Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_old_gen.used
Used memory of the G1 Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_survivor_space.committed
Committed memory of the G1 Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_survivor_space.init
Init memory of the G1 Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_survivor_space.max
Max memory of the G1 Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.g1_survivor_space.used
Used memory of the G1 Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.metaspace.committed
Committed memory of the metaspace memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.metaspace.init
Init memory of the metaspace memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.metaspace.max
Max memory of the metaspace memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.metaspace.used
Used memory of the metaspace memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_eden_space.committed
Committed memory of the PS Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_eden_space.init
Init memory of the PS Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_eden_space.max
Max memory of the PS Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_eden_space.used
Used memory of the PS Eden Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_old_gen.committed
Committed memory of the PS Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_old_gen.init
Init memory of the PS Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_old_gen.max
Max memory of the PS Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_old_gen.used
Used memory of the PS Old Gen memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_survivor_space.committed
Committed memory of the PS Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_survivor_space.init
Init memory of the PS Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_survivor_space.max
Max memory of the PS Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.after.ps_survivor_space.used
Used memory of the PS Survivor Space memory pool after GC started.
long
byte
spring_boot.gc.last_info.memory_usage.before.code_cache.committed
Committed memory of the code cache memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.code_cache.init
Init memory of the code cache memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.code_cache.max
Max memory of the code cache memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.code_cache.used
Used memory of the code cache memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.compressed_class_space.committed
Committed memory of the compressed class space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.compressed_class_space.init
Init memory of the compressed class space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.compressed_class_space.max
Max memory of the compressed class space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.compressed_class_space.used
Used memory of the compressed class space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_eden_space.committed
Committed memory of the G1 Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_eden_space.init
Init memory of the G1 Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_eden_space.max
Max memory of the G1 Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_eden_space.used
Used memory of the G1 Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_old_gen.committed
Committed memory of the G1 Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_old_gen.init
Init memory of the G1 Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_old_gen.max
Max memory of the G1 Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_old_gen.used
Used memory of the G1 Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_survivor_space.committed
Committed memory of the G1 Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_survivor_space.init
Init memory of the G1 Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_survivor_space.max
Max memory of the G1 Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.g1_survivor_space.used
Used memory of the G1 Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.metaspace.committed
Committed memory of the metaspace memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.metaspace.init
Init memory of the metaspace memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.metaspace.max
Max memory of the metaspace memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.metaspace.used
Used memory of the metaspace memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_eden_space.committed
Committed memory of the PS Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_eden_space.init
Init memory of the PS Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_eden_space.max
Max memory of the PS Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_eden_space.used
Used memory of the PS Eden Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_old_gen.committed
Committed memory of the PS Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_old_gen.init
Init memory of the PS Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_old_gen.max
Max memory of the PS Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_old_gen.used
Used memory of the PS Old Gen memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_survivor_space.committed
Committed memory of the PS Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_survivor_space.init
Init memory of the PS Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_survivor_space.max
Max memory of the PS Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.memory_usage.before.ps_survivor_space.used
Used memory of the PS Survivor Space memory pool before GC starts.
long
byte
spring_boot.gc.last_info.thread_count
Thread count of the GC.
long
spring_boot.gc.last_info.time.duration
Elapsed time of the GC in milliseconds.
long
ms
spring_boot.gc.last_info.time.end
End time of the GC.
long
ms
spring_boot.gc.last_info.time.start
Start time of the GC.
long
ms
spring_boot.gc.name
Name of the GC.
keyword
tags
List of keywords used to tag each event.
keyword

Changelog

VersionDetailsKibana version(s)

1.3.1

Enhancement View pull request
Update README to follow documentation guidelines.

8.9.0 or higher

1.3.0

Enhancement View pull request
Enable 'secret' for the sensitive fields, supported from 8.12.

8.9.0 or higher

1.2.2

Enhancement View pull request
Inline "by reference" visualizations

8.9.0 or higher

1.2.1

Bug fix View pull request
Add null and ignore_missing check to handle event.original field.

8.9.0 or higher

1.2.0

Enhancement View pull request
Add support for GC datastream on Spring Boot 2.x with LTS JDK versions 11, 17, and 21.

8.9.0 or higher

1.1.0

Enhancement View pull request
Limit request tracer log count to five.

8.9.0 or higher

1.0.0

Enhancement View pull request
Make Spring Boot GA.

8.9.0 or higher

0.13.0

Enhancement View pull request
Update the package format_version to 3.0.0.

0.12.0

Enhancement View pull request
Support tags to GC, Memory and Threading.

0.11.1

Bug fix View pull request
Resolve host.ip field conflict, update readme and remove incorrect rename processor.

0.11.0

Enhancement View pull request
Add support for HTTP request trace logging.

0.10.0

Enhancement View pull request
Rename ownership from obs-service-integrations to obs-infraobs-integrations

0.9.0

Enhancement View pull request
Add custom field for _id and update dashboard.

0.8.0

Enhancement View pull request
Migrate visualizations to lens.

0.7.1

Enhancement View pull request
Added categories and/or subcategories.

0.7.0

Enhancement View pull request
Update ECS version to 8.5.1

0.6.1

Bug fix View pull request
visualization bugfix for audit_event data stream

0.6.0

Enhancement View pull request
dashboards of audit_events, http_trace, memory, threading and garbage collector (GC) of the package

0.5.0

Enhancement View pull request
garbage collector (gc) data stream of the package

0.4.0

Enhancement View pull request
threading data stream of the package

0.3.0

Enhancement View pull request
memory data stream of the package

0.2.0

Enhancement View pull request
http_trace data stream of the package

0.1.0

Enhancement View pull request
audit_events data stream of the package

On this page