{ "name": "spring_boot", "title": "Spring Boot", "version": "1.7.1", "release": "ga", "description": "This Elastic integration collects logs and metrics from Spring Boot integration.", "type": "integration", "download": "/epr/spring_boot/spring_boot-1.7.1.zip", "path": "/package/spring_boot/1.7.1", "icons": [ { "src": "/img/spring_boot-logo.svg", "path": "/package/spring_boot/1.7.1/img/spring_boot-logo.svg", "title": "Spring Boot logo", "size": "32x32", "type": "image/svg+xml" } ], "conditions": { "kibana": { "version": "^8.13.0" }, "elastic": { "subscription": "basic" } }, "owner": { "type": "elastic", "github": "elastic/obs-infraobs-integrations" }, "categories": [ "observability", "java_observability" ], "signature_path": "/epr/spring_boot/spring_boot-1.7.1.zip.sig", "format_version": "3.0.2", "readme": "/package/spring_boot/1.7.1/docs/README.md", "license": "basic", "screenshots": [ { "src": "/img/spring_boot-overview-dashboard.png", "path": "/package/spring_boot/1.7.1/img/spring_boot-overview-dashboard.png", "title": "Spring Boot overview dashboard", "size": "600x600", "type": "image/png" }, { "src": "/img/spring_boot-audit_events-dashboard.png", "path": "/package/spring_boot/1.7.1/img/spring_boot-audit_events-dashboard.png", "title": "Spring Boot audit events dashboard", "size": "600x600", "type": "image/png" }, { "src": "/img/spring_boot-access_logs-dashboard.png", "path": "/package/spring_boot/1.7.1/img/spring_boot-access_logs-dashboard.png", "title": "Spring Boot access logs dashboard", "size": "600x600", "type": "image/png" }, { "src": "/img/spring_boot-memory-threading-dashboard.png", "path": "/package/spring_boot/1.7.1/img/spring_boot-memory-threading-dashboard.png", "title": "Spring Boot memory and threading dashboard", "size": "600x600", "type": "image/png" } ], "assets": [ "/package/spring_boot/1.7.1/LICENSE.txt", "/package/spring_boot/1.7.1/changelog.yml", "/package/spring_boot/1.7.1/manifest.yml", "/package/spring_boot/1.7.1/docs/README.md", "/package/spring_boot/1.7.1/img/spring_boot-access_logs-dashboard.png", "/package/spring_boot/1.7.1/img/spring_boot-audit_events-dashboard.png", "/package/spring_boot/1.7.1/img/spring_boot-logo.svg", "/package/spring_boot/1.7.1/img/spring_boot-memory-threading-dashboard.png", "/package/spring_boot/1.7.1/img/spring_boot-overview-dashboard.png", "/package/spring_boot/1.7.1/data_stream/audit_events/manifest.yml", "/package/spring_boot/1.7.1/data_stream/audit_events/sample_event.json", "/package/spring_boot/1.7.1/data_stream/gc/manifest.yml", "/package/spring_boot/1.7.1/data_stream/gc/sample_event.json", "/package/spring_boot/1.7.1/data_stream/http_trace/manifest.yml", "/package/spring_boot/1.7.1/data_stream/http_trace/sample_event.json", "/package/spring_boot/1.7.1/data_stream/memory/manifest.yml", "/package/spring_boot/1.7.1/data_stream/memory/sample_event.json", "/package/spring_boot/1.7.1/data_stream/threading/manifest.yml", "/package/spring_boot/1.7.1/data_stream/threading/sample_event.json", "/package/spring_boot/1.7.1/kibana/dashboard/spring_boot-6fe11330-c7f1-11ec-986a-f1e84447fd00.json", "/package/spring_boot/1.7.1/kibana/dashboard/spring_boot-6fe782d0-ca15-11ec-b4b1-b57f75afa7dd.json", "/package/spring_boot/1.7.1/kibana/dashboard/spring_boot-c89e1510-ca15-11ec-b4b1-b57f75afa7dd.json", "/package/spring_boot/1.7.1/kibana/dashboard/spring_boot-e8507040-c7b0-11ec-9c82-4b3dfe36a746.json", "/package/spring_boot/1.7.1/data_stream/audit_events/fields/base-fields.yml", "/package/spring_boot/1.7.1/data_stream/audit_events/fields/fields.yml", "/package/spring_boot/1.7.1/data_stream/gc/fields/base-fields.yml", "/package/spring_boot/1.7.1/data_stream/gc/fields/fields.yml", "/package/spring_boot/1.7.1/data_stream/http_trace/fields/base-fields.yml", "/package/spring_boot/1.7.1/data_stream/http_trace/fields/fields.yml", "/package/spring_boot/1.7.1/data_stream/memory/fields/base-fields.yml", "/package/spring_boot/1.7.1/data_stream/memory/fields/fields.yml", "/package/spring_boot/1.7.1/data_stream/threading/fields/base-fields.yml", "/package/spring_boot/1.7.1/data_stream/threading/fields/fields.yml", "/package/spring_boot/1.7.1/data_stream/audit_events/agent/stream/stream.yml.hbs", "/package/spring_boot/1.7.1/data_stream/audit_events/elasticsearch/ingest_pipeline/default.yml", "/package/spring_boot/1.7.1/data_stream/gc/agent/stream/stream.yml.hbs", "/package/spring_boot/1.7.1/data_stream/gc/elasticsearch/ingest_pipeline/default.yml", "/package/spring_boot/1.7.1/data_stream/http_trace/agent/stream/stream.yml.hbs", "/package/spring_boot/1.7.1/data_stream/http_trace/elasticsearch/ingest_pipeline/default.yml", "/package/spring_boot/1.7.1/data_stream/memory/agent/stream/stream.yml.hbs", "/package/spring_boot/1.7.1/data_stream/memory/elasticsearch/ingest_pipeline/default.yml", "/package/spring_boot/1.7.1/data_stream/threading/agent/stream/stream.yml.hbs", "/package/spring_boot/1.7.1/data_stream/threading/elasticsearch/ingest_pipeline/default.yml" ], "policy_templates": [ { "name": "spring_boot", "title": "Spring Boot metrics", "description": "Collect Spring Boot metrics.", "inputs": [ { "type": "httpjson", "vars": [ { "name": "hostname", "type": "text", "title": "URL of Spring Boot API Server", "description": "Full host for the Spring Boot Events API (Example: http://localhost:8090). For username and password http[s]://:@:.\n", "multi": false, "required": true, "show_user": true }, { "name": "ssl", "type": "yaml", "title": "SSL Configuration", "description": "i.e. certificate_authorities, supported_protocols, verification_mode etc.", "multi": false, "required": false, "show_user": false, "default": "#certificate_authorities:\n# - |\n# -----BEGIN CERTIFICATE-----\n# MIIDCjCCAfKgAwIBAgITJ706Mu2wJlKckpIvkWxEHvEyijANBgkqhkiG9w0BAQsF\n# ADAUMRIwEAYDVQQDDAlsb2NhbGhvc3QwIBcNMTkwNzIyMTkyOTA0WhgPMjExOTA2\n# MjgxOTI5MDRaMBQxEjAQBgNVBAMMCWxvY2FsaG9zdDCCASIwDQYJKoZIhvcNAQEB\n# BQADggEPADCCAQoCggEBANce58Y/JykI58iyOXpxGfw0/gMvF0hUQAcUrSMxEO6n\n# fZRA49b4OV4SwWmA3395uL2eB2NB8y8qdQ9muXUdPBWE4l9rMZ6gmfu90N5B5uEl\n# 94NcfBfYOKi1fJQ9i7WKhTjlRkMCgBkWPkUokvBZFRt8RtF7zI77BSEorHGQCk9t\n# /D7BS0GJyfVEhftbWcFEAG3VRcoMhF7kUzYwp+qESoriFRYLeDWv68ZOvG7eoWnP\n# PsvZStEVEimjvK5NSESEQa9xWyJOmlOKXhkdymtcUd/nXnx6UTCFgnkgzSdTWV41\n# CI6B6aJ9svCTI2QuoIq2HxX/ix7OvW1huVmcyHVxyUECAwEAAaNTMFEwHQYDVR0O\n# BBYEFPwN1OceFGm9v6ux8G+DZ3TUDYxqMB8GA1UdIwQYMBaAFPwN1OceFGm9v6ux\n# 8G+DZ3TUDYxqMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAG5D\n# 874A4YI7YUwOVsVAdbWtgp1d0zKcPRR+r2OdSbTAV5/gcS3jgBJ3i1BN34JuDVFw\n# 3DeJSYT3nxy2Y56lLnxDeF8CUTUtVQx3CuGkRg1ouGAHpO/6OqOhwLLorEmxi7tA\n# H2O8mtT0poX5AnOAhzVy7QW0D/k4WaoLyckM5hUa6RtvgvLxOwA0U+VGurCDoctu\n# 8F4QOgTAWyh8EZIwaKCliFRSynDpv3JTUwtfZkxo6K6nce1RhCWFAsMvDZL8Dgc0\n# yvgJ38BRsFOtkRuAGSf6ZUwTO8JJRRIFnpUzXflAnGivK9M13D5GEQMmIl6U9Pvk\n# sxSmbIUfc2SGJGCJD4I=\n# -----END CERTIFICATE----- \n" }, { "name": "enable_request_tracer", "type": "bool", "title": "Enable request tracing", "description": "The request tracer logs requests and responses to the agent's local file-system for debugging configurations. Enabling this request tracing compromises security and should only be used for debugging. See [documentation](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-httpjson.html#_request_tracer_filename) for details.", "multi": false, "required": false, "show_user": false } ], "title": "Collect events from Spring Boot Events API", "description": "Collect metrics via the Spring Boot Events API." }, { "type": "jolokia/metrics", "vars": [ { "name": "path", "type": "text", "title": "Path", "multi": false, "required": true, "show_user": false, "default": "/jolokia/?ignoreErrors=true&canonicalNaming=false" }, { "name": "username", "type": "text", "title": "Username", "multi": false, "required": false, "show_user": false, "default": "actuator" }, { "name": "password", "type": "password", "title": "Password", "multi": false, "required": false, "show_user": false, "default": "actuator" }, { "name": "hosts", "type": "text", "title": "Hosts", "description": "Host for Spring Boot metrics. (example: http://localhost:8090/actuator/jolokia).", "multi": false, "required": true, "show_user": true }, { "name": "ssl", "type": "yaml", "title": "SSL Configuration", "description": "i.e. certificate_authorities, supported_protocols, verification_mode etc.", "multi": false, "required": false, "show_user": false, "default": "#certificate_authorities:\n# - |\n# -----BEGIN CERTIFICATE-----\n# MIIDCjCCAfKgAwIBAgITJ706Mu2wJlKckpIvkWxEHvEyijANBgkqhkiG9w0BAQsF\n# ADAUMRIwEAYDVQQDDAlsb2NhbGhvc3QwIBcNMTkwNzIyMTkyOTA0WhgPMjExOTA2\n# MjgxOTI5MDRaMBQxEjAQBgNVBAMMCWxvY2FsaG9zdDCCASIwDQYJKoZIhvcNAQEB\n# BQADggEPADCCAQoCggEBANce58Y/JykI58iyOXpxGfw0/gMvF0hUQAcUrSMxEO6n\n# fZRA49b4OV4SwWmA3395uL2eB2NB8y8qdQ9muXUdPBWE4l9rMZ6gmfu90N5B5uEl\n# 94NcfBfYOKi1fJQ9i7WKhTjlRkMCgBkWPkUokvBZFRt8RtF7zI77BSEorHGQCk9t\n# /D7BS0GJyfVEhftbWcFEAG3VRcoMhF7kUzYwp+qESoriFRYLeDWv68ZOvG7eoWnP\n# PsvZStEVEimjvK5NSESEQa9xWyJOmlOKXhkdymtcUd/nXnx6UTCFgnkgzSdTWV41\n# CI6B6aJ9svCTI2QuoIq2HxX/ix7OvW1huVmcyHVxyUECAwEAAaNTMFEwHQYDVR0O\n# BBYEFPwN1OceFGm9v6ux8G+DZ3TUDYxqMB8GA1UdIwQYMBaAFPwN1OceFGm9v6ux\n# 8G+DZ3TUDYxqMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAG5D\n# 874A4YI7YUwOVsVAdbWtgp1d0zKcPRR+r2OdSbTAV5/gcS3jgBJ3i1BN34JuDVFw\n# 3DeJSYT3nxy2Y56lLnxDeF8CUTUtVQx3CuGkRg1ouGAHpO/6OqOhwLLorEmxi7tA\n# H2O8mtT0poX5AnOAhzVy7QW0D/k4WaoLyckM5hUa6RtvgvLxOwA0U+VGurCDoctu\n# 8F4QOgTAWyh8EZIwaKCliFRSynDpv3JTUwtfZkxo6K6nce1RhCWFAsMvDZL8Dgc0\n# yvgJ38BRsFOtkRuAGSf6ZUwTO8JJRRIFnpUzXflAnGivK9M13D5GEQMmIl6U9Pvk\n# sxSmbIUfc2SGJGCJD4I=\n# -----END CERTIFICATE----- \n" } ], "title": "Collect Spring Boot metrics using Jolokia", "description": "Collecting metrics from Spring Boot of Memory, Threading and Garbage Collector (GC) using Jolokia." } ], "multiple": true } ], "data_streams": [ { "type": "logs", "dataset": "spring_boot.audit_events", "title": "Audit Events", "release": "ga", "ingest_pipeline": "default", "streams": [ { "input": "httpjson", "vars": [ { "name": "period", "type": "text", "title": "Period", "multi": false, "required": false, "show_user": false, "default": "60s" }, { "name": "tags", "type": "text", "title": "Tags", "multi": true, "required": true, "show_user": false, "default": [ "spring_boot.audit_events.metrics" ] }, { "name": "preserve_original_event", "type": "bool", "title": "Preserve original event", "description": "Preserves a raw copy of the original event, added to the field `event.original`.", "multi": false, "required": true, "show_user": true, "default": false }, { "name": "processors", "type": "yaml", "title": "Processors", "description": "Processors are used to reduce the number of fields in the exported event or to enhance the event with metadata. This executes in the agent before the logs are parsed. See [Processors](https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html) for details.\n", "multi": false, "required": false, "show_user": false } ], "template_path": "stream.yml.hbs", "title": "Spring Boot Audit Events metrics", "description": "Collect Spring Boot Audit Events metrics.", "enabled": true, "ingestion_method": "API" } ], "package": "spring_boot", "path": "audit_events" }, { "type": "metrics", "dataset": "spring_boot.gc", "title": "Garbage Collector (GC) Metrics", "release": "ga", "ingest_pipeline": "default", "streams": [ { "input": "jolokia/metrics", "vars": [ { "name": "period", "type": "text", "title": "Period", "multi": false, "required": false, "show_user": false, "default": "60s" }, { "name": "tags", "type": "text", "title": "Tags", "multi": true, "required": true, "show_user": false, "default": [ "spring_boot.gc.metrics" ] }, { "name": "processors", "type": "yaml", "title": "Processors", "description": "Processors are used to reduce the number of fields in the exported event or to enhance the event with metadata. This executes in the agent before the logs are parsed. See [Processors](https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html) for details.\n", "multi": false, "required": false, "show_user": false } ], "template_path": "stream.yml.hbs", "title": "Garbage Collector (GC) metrics", "description": "Collect Spring Boot Garbage Collector (GC) metrics.", "enabled": true, "ingestion_method": "Jolokia" } ], "package": "spring_boot", "path": "gc" }, { "type": "logs", "dataset": "spring_boot.http_trace", "title": "HTTP Trace Metrics", "release": "ga", "ingest_pipeline": "default", "streams": [ { "input": "httpjson", "vars": [ { "name": "period", "type": "text", "title": "Period", "multi": false, "required": false, "show_user": false, "default": "60s" }, { "name": "tags", "type": "text", "title": "Tags", "multi": true, "required": true, "show_user": false, "default": [ "spring_boot.http_trace.metrics" ] }, { "name": "preserve_original_event", "type": "bool", "title": "Preserve original event", "description": "Preserves a raw copy of the original event, added to the field `event.original`.", "multi": false, "required": true, "show_user": true, "default": false }, { "name": "processors", "type": "yaml", "title": "Processors", "description": "Processors are used to reduce the number of fields in the exported event or to enhance the event with metadata. This executes in the agent before the logs are parsed. See [Processors](https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html) for details.\n", "multi": false, "required": false, "show_user": false } ], "template_path": "stream.yml.hbs", "title": "Spring Boot HTTP Trace metrics", "description": "Collect Spring Boot HTTP Trace metrics.", "enabled": true, "ingestion_method": "API" } ], "package": "spring_boot", "path": "http_trace" }, { "type": "metrics", "dataset": "spring_boot.memory", "title": "Memory Metrics", "release": "ga", "ingest_pipeline": "default", "streams": [ { "input": "jolokia/metrics", "vars": [ { "name": "period", "type": "text", "title": "Period", "multi": false, "required": false, "show_user": false, "default": "60s" }, { "name": "tags", "type": "text", "title": "Tags", "multi": true, "required": true, "show_user": false, "default": [ "spring_boot.memory.metrics" ] }, { "name": "processors", "type": "yaml", "title": "Processors", "description": "Processors are used to reduce the number of fields in the exported event or to enhance the event with metadata. This executes in the agent before the logs are parsed. See [Processors](https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html) for details.\n", "multi": false, "required": false, "show_user": false } ], "template_path": "stream.yml.hbs", "title": "Memory metrics", "description": "Collect Spring Boot Memory metrics.", "enabled": true, "ingestion_method": "Jolokia" } ], "package": "spring_boot", "path": "memory" }, { "type": "metrics", "dataset": "spring_boot.threading", "title": "Threading Metrics", "release": "ga", "ingest_pipeline": "default", "streams": [ { "input": "jolokia/metrics", "vars": [ { "name": "period", "type": "text", "title": "Period", "multi": false, "required": false, "show_user": false, "default": "60s" }, { "name": "tags", "type": "text", "title": "Tags", "multi": true, "required": true, "show_user": false, "default": [ "spring_boot.threading.metrics" ] }, { "name": "processors", "type": "yaml", "title": "Processors", "description": "Processors are used to reduce the number of fields in the exported event or to enhance the event with metadata. This executes in the agent before the logs are parsed. See [Processors](https://www.elastic.co/guide/en/beats/filebeat/current/filtering-and-enhancing-data.html) for details.\n", "multi": false, "required": false, "show_user": false } ], "template_path": "stream.yml.hbs", "title": "Threading metrics", "description": "Collect Spring Boot Threading metrics.", "enabled": true, "ingestion_method": "Jolokia" } ], "package": "spring_boot", "path": "threading" } ] }